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/>.
25 #include "modules/regex.h"
26 #include "modules/server.h"
55 bool flag_part_message;
56 bool flag_quit_message;
59 bool flag_strip_color;
61 FilterResult(dynamic_reference<RegexFactory>& RegexEngine, const std::string& free, const std::string& rea, FilterAction act, long gt, const std::string& fla)
62 : freeform(free), reason(rea), action(act), gline_time(gt)
65 throw ModuleException("Regex module implementing '"+RegexEngine.GetProvider()+"' is not loaded!");
66 regex = RegexEngine->Create(free);
70 char FillFlags(const std::string &fl)
72 flag_no_opers = flag_part_message = flag_quit_message = flag_privmsg =
73 flag_notice = flag_strip_color = false;
75 for (std::string::const_iterator n = fl.begin(); n != fl.end(); ++n)
83 flag_part_message = true;
86 flag_quit_message = true;
95 flag_strip_color = true;
98 flag_no_opers = flag_part_message = flag_quit_message =
99 flag_privmsg = flag_notice = flag_strip_color = true;
109 std::string GetFlags()
113 flags.push_back('o');
114 if (flag_part_message)
115 flags.push_back('P');
116 if (flag_quit_message)
117 flags.push_back('q');
119 flags.push_back('p');
121 flags.push_back('n');
123 /* Order is important here, 'c' must be the last char in the string as it is unsupported
124 * on < 2.0.10, and the logic in FillFlags() stops parsing when it ecounters an unknown
127 if (flag_strip_color)
128 flags.push_back('c');
131 flags.push_back('-');
141 class CommandFilter : public Command
144 CommandFilter(Module* f)
145 : Command(f, "FILTER", 1, 5)
148 this->syntax = "<filter-definition> <action> <flags> [<gline-duration>] :<reason>";
150 CmdResult Handle(const std::vector<std::string>& , User* ) CXX11_OVERRIDE;
152 RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters) CXX11_OVERRIDE
154 return ROUTE_BROADCAST;
158 class ModuleFilter : public Module, public ServerEventListener
160 typedef insp::flat_set<std::string, irc::insensitive_swo> ExemptTargetSet;
163 RegexFactory* factory;
167 CommandFilter filtcommand;
168 dynamic_reference<RegexFactory> RegexEngine;
170 std::vector<FilterResult> filters;
173 // List of channel names excluded from filtering.
174 ExemptTargetSet exemptedchans;
176 // List of target nicknames excluded from filtering.
177 ExemptTargetSet exemptednicks;
180 CullResult cull() CXX11_OVERRIDE;
181 ModResult OnUserPreMessage(User* user, void* dest, int target_type, std::string& text, char status, CUList& exempt_list, MessageType msgtype) CXX11_OVERRIDE;
182 FilterResult* FilterMatch(User* user, const std::string &text, int flags);
183 bool DeleteFilter(const std::string &freeform);
184 std::pair<bool, std::string> AddFilter(const std::string &freeform, FilterAction type, const std::string &reason, long duration, const std::string &flags);
185 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE;
186 Version GetVersion() CXX11_OVERRIDE;
187 std::string EncodeFilter(FilterResult* filter);
188 FilterResult DecodeFilter(const std::string &data);
189 void OnSyncNetwork(ProtocolInterface::Server& server) CXX11_OVERRIDE;
190 void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata) CXX11_OVERRIDE;
191 ModResult OnStats(Stats::Context& stats) CXX11_OVERRIDE;
192 ModResult OnPreCommand(std::string &command, std::vector<std::string> ¶meters, LocalUser *user, bool validated, const std::string &original_line) CXX11_OVERRIDE;
193 void OnUnloadModule(Module* mod) CXX11_OVERRIDE;
194 bool AppliesToMe(User* user, FilterResult* filter, int flags);
196 static bool StringToFilterAction(const std::string& str, FilterAction& fa);
197 static std::string FilterActionToString(FilterAction fa);
200 CmdResult CommandFilter::Handle(const std::vector<std::string> ¶meters, User *user)
202 if (parameters.size() == 1)
204 /* Deleting a filter */
205 Module *me = creator;
206 if (static_cast<ModuleFilter *>(me)->DeleteFilter(parameters[0]))
208 user->WriteNotice("*** Removed filter '" + parameters[0] + "'");
209 ServerInstance->SNO->WriteToSnoMask(IS_LOCAL(user) ? 'a' : 'A', "FILTER: "+user->nick+" removed filter '"+parameters[0]+"'");
214 user->WriteNotice("*** Filter '" + parameters[0] + "' not found in list, try /stats s.");
220 /* Adding a filter */
221 if (parameters.size() >= 4)
223 const std::string& freeform = parameters[0];
225 const std::string& flags = parameters[2];
226 unsigned int reasonindex;
229 if (!ModuleFilter::StringToFilterAction(parameters[1], type))
231 user->WriteNotice("*** Invalid filter type '" + parameters[1] + "'. Supported types are 'gline', 'none', 'block', 'silent' and 'kill'.");
235 if (type == FA_GLINE)
237 if (parameters.size() >= 5)
239 duration = InspIRCd::Duration(parameters[3]);
244 user->WriteNotice("*** Not enough parameters: When setting a gline type filter, a gline duration must be specified as the third parameter.");
253 Module *me = creator;
254 std::pair<bool, std::string> result = static_cast<ModuleFilter *>(me)->AddFilter(freeform, type, parameters[reasonindex], duration, flags);
257 user->WriteNotice("*** Added filter '" + freeform + "', type '" + parameters[1] + "'" +
258 (duration ? ", duration " + parameters[3] : "") + ", flags '" + flags + "', reason: '" +
259 parameters[reasonindex] + "'");
261 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]);
267 user->WriteNotice("*** Filter '" + freeform + "' could not be added: " + result.second);
273 user->WriteNotice("*** Not enough parameters.");
280 bool ModuleFilter::AppliesToMe(User* user, FilterResult* filter, int iflags)
282 if ((filter->flag_no_opers) && user->IsOper())
284 if ((iflags & FLAG_PRIVMSG) && (!filter->flag_privmsg))
286 if ((iflags & FLAG_NOTICE) && (!filter->flag_notice))
288 if ((iflags & FLAG_QUIT) && (!filter->flag_quit_message))
290 if ((iflags & FLAG_PART) && (!filter->flag_part_message))
295 ModuleFilter::ModuleFilter()
296 : ServerEventListener(this)
299 , RegexEngine(this, "regex")
303 CullResult ModuleFilter::cull()
306 return Module::cull();
309 void ModuleFilter::FreeFilters()
311 for (std::vector<FilterResult>::const_iterator i = filters.begin(); i != filters.end(); ++i)
317 ModResult ModuleFilter::OnUserPreMessage(User* user, void* dest, int target_type, std::string& text, char status, CUList& exempt_list, MessageType msgtype)
319 // Leave remote users and servers alone
321 return MOD_RES_PASSTHRU;
323 flags = (msgtype == MSG_PRIVMSG) ? FLAG_PRIVMSG : FLAG_NOTICE;
325 FilterResult* f = this->FilterMatch(user, text, flags);
329 if (target_type == TYPE_USER)
331 User* t = (User*)dest;
332 // Check if the target nick is exempted, if yes, ignore this message
333 if (exemptednicks.count(t->nick))
334 return MOD_RES_PASSTHRU;
338 else if (target_type == TYPE_CHANNEL)
340 Channel* t = (Channel*)dest;
341 if (exemptedchans.count(t->name))
342 return MOD_RES_PASSTHRU;
346 if (f->action == FA_BLOCK)
348 ServerInstance->SNO->WriteGlobalSno('a', "FILTER: "+user->nick+" had their message filtered, target was "+target+": "+f->reason);
349 if (target_type == TYPE_CHANNEL)
350 user->WriteNumeric(ERR_CANNOTSENDTOCHAN, target, InspIRCd::Format("Message to channel blocked and opers notified (%s)", f->reason.c_str()));
352 user->WriteNotice("Your message to "+target+" was blocked and opers notified: "+f->reason);
354 else if (f->action == FA_SILENT)
356 if (target_type == TYPE_CHANNEL)
357 user->WriteNumeric(ERR_CANNOTSENDTOCHAN, target, InspIRCd::Format("Message to channel blocked (%s)", f->reason.c_str()));
359 user->WriteNotice("Your message to "+target+" was blocked: "+f->reason);
361 else if (f->action == FA_KILL)
363 ServerInstance->SNO->WriteGlobalSno('a', "FILTER: " + user->nick + " had their message filtered and was killed, target was " + target + ": " + f->reason);
364 ServerInstance->Users->QuitUser(user, "Filtered: " + f->reason);
366 else if (f->action == FA_GLINE)
368 GLine* gl = new GLine(ServerInstance->Time(), f->gline_time, ServerInstance->Config->ServerName.c_str(), f->reason.c_str(), "*", user->GetIPString());
369 ServerInstance->SNO->WriteGlobalSno('a', "FILTER: " + user->nick + " had their message filtered and was G-Lined, target was " + target + ": " + f->reason);
370 if (ServerInstance->XLines->AddLine(gl,NULL))
372 ServerInstance->XLines->ApplyLines();
378 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, user->nick + " had their message filtered, target was " + target + ": " + f->reason + " Action: " + ModuleFilter::FilterActionToString(f->action));
381 return MOD_RES_PASSTHRU;
384 ModResult ModuleFilter::OnPreCommand(std::string &command, std::vector<std::string> ¶meters, LocalUser *user, bool validated, const std::string &original_line)
391 if (command == "QUIT")
393 /* QUIT with no reason: nothing to do */
394 if (parameters.size() < 1)
395 return MOD_RES_PASSTHRU;
400 else if (command == "PART")
402 /* PART with no reason: nothing to do */
403 if (parameters.size() < 2)
404 return MOD_RES_PASSTHRU;
406 if (exemptedchans.count(parameters[0]))
407 return MOD_RES_PASSTHRU;
413 /* We're only messing with PART and QUIT */
414 return MOD_RES_PASSTHRU;
416 FilterResult* f = this->FilterMatch(user, parameters[parting ? 1 : 0], flags);
418 /* PART or QUIT reason doesnt match a filter */
419 return MOD_RES_PASSTHRU;
421 /* We cant block a part or quit, so instead we change the reason to 'Reason filtered' */
422 parameters[parting ? 1 : 0] = "Reason filtered";
424 /* We're blocking, OR theyre quitting and its a KILL action
425 * (we cant kill someone whos already quitting, so filter them anyway)
427 if ((f->action == FA_BLOCK) || (((!parting) && (f->action == FA_KILL))) || (f->action == FA_SILENT))
429 return MOD_RES_PASSTHRU;
433 /* Are they parting, if so, kill is applicable */
434 if ((parting) && (f->action == FA_KILL))
436 user->WriteNotice("*** Your PART message was filtered: " + f->reason);
437 ServerInstance->Users->QuitUser(user, "Filtered: " + f->reason);
439 if (f->action == FA_GLINE)
441 /* Note: We gline *@IP so that if their host doesnt resolve the gline still applies. */
442 GLine* gl = new GLine(ServerInstance->Time(), f->gline_time, ServerInstance->Config->ServerName.c_str(), f->reason.c_str(), "*", user->GetIPString());
443 if (ServerInstance->XLines->AddLine(gl,NULL))
445 ServerInstance->XLines->ApplyLines();
453 return MOD_RES_PASSTHRU;
456 void ModuleFilter::ReadConfig(ConfigStatus& status)
458 ConfigTagList tags = ServerInstance->Config->ConfTags("exemptfromfilter");
459 exemptedchans.clear();
460 exemptednicks.clear();
462 for (ConfigIter i = tags.first; i != tags.second; ++i)
464 ConfigTag* tag = i->second;
466 // If "target" is not found, try the old "channel" key to keep compatibility with 2.0 configs
467 const std::string target = tag->getString("target", tag->getString("channel"));
470 if (target[0] == '#')
471 exemptedchans.insert(target);
473 exemptednicks.insert(target);
477 std::string newrxengine = ServerInstance->Config->ConfValue("filteropts")->getString("engine");
479 factory = RegexEngine ? (RegexEngine.operator->()) : NULL;
481 if (newrxengine.empty())
482 RegexEngine.SetProvider("regex");
484 RegexEngine.SetProvider("regex/" + newrxengine);
488 if (newrxengine.empty())
489 ServerInstance->SNO->WriteGlobalSno('a', "WARNING: No regex engine loaded - Filter functionality disabled until this is corrected.");
491 ServerInstance->SNO->WriteGlobalSno('a', "WARNING: Regex engine '%s' is not loaded - Filter functionality disabled until this is corrected.", newrxengine.c_str());
498 if ((!initing) && (RegexEngine.operator->() != factory))
500 ServerInstance->SNO->WriteGlobalSno('a', "Dumping all filters due to regex engine change");
508 Version ModuleFilter::GetVersion()
510 return Version("Text (spam) filtering", VF_VENDOR | VF_COMMON, RegexEngine ? RegexEngine->name : "");
513 std::string ModuleFilter::EncodeFilter(FilterResult* filter)
515 std::ostringstream stream;
516 std::string x = filter->freeform;
518 /* Hax to allow spaces in the freeform without changing the design of the irc protocol */
519 for (std::string::iterator n = x.begin(); n != x.end(); n++)
523 stream << x << " " << FilterActionToString(filter->action) << " " << filter->GetFlags() << " " << filter->gline_time << " :" << filter->reason;
527 FilterResult ModuleFilter::DecodeFilter(const std::string &data)
529 std::string filteraction;
531 irc::tokenstream tokens(data);
532 tokens.GetToken(res.freeform);
533 tokens.GetToken(filteraction);
534 if (!StringToFilterAction(filteraction, res.action))
535 throw ModuleException("Invalid action: " + filteraction);
537 std::string filterflags;
538 tokens.GetToken(filterflags);
539 char c = res.FillFlags(filterflags);
541 throw ModuleException("Invalid flag: '" + std::string(1, c) + "'");
543 tokens.GetToken(res.gline_time);
544 tokens.GetToken(res.reason);
546 /* Hax to allow spaces in the freeform without changing the design of the irc protocol */
547 for (std::string::iterator n = res.freeform.begin(); n != res.freeform.end(); n++)
554 void ModuleFilter::OnSyncNetwork(ProtocolInterface::Server& server)
556 for (std::vector<FilterResult>::iterator i = filters.begin(); i != filters.end(); ++i)
558 server.SendMetaData("filter", EncodeFilter(&(*i)));
562 void ModuleFilter::OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata)
564 if ((target == NULL) && (extname == "filter"))
568 FilterResult data = DecodeFilter(extdata);
569 this->AddFilter(data.freeform, data.action, data.reason, data.gline_time, data.GetFlags());
571 catch (ModuleException& e)
573 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Error when unserializing filter: " + e.GetReason());
578 FilterResult* ModuleFilter::FilterMatch(User* user, const std::string &text, int flgs)
580 static std::string stripped_text;
581 stripped_text.clear();
583 for (std::vector<FilterResult>::iterator i = filters.begin(); i != filters.end(); ++i)
585 FilterResult* filter = &*i;
587 /* Skip ones that dont apply to us */
588 if (!AppliesToMe(user, filter, flgs))
591 if ((filter->flag_strip_color) && (stripped_text.empty()))
593 stripped_text = text;
594 InspIRCd::StripColor(stripped_text);
597 if (filter->regex->Matches(filter->flag_strip_color ? stripped_text : text))
603 bool ModuleFilter::DeleteFilter(const std::string &freeform)
605 for (std::vector<FilterResult>::iterator i = filters.begin(); i != filters.end(); i++)
607 if (i->freeform == freeform)
617 std::pair<bool, std::string> ModuleFilter::AddFilter(const std::string &freeform, FilterAction type, const std::string &reason, long duration, const std::string &flgs)
619 for (std::vector<FilterResult>::iterator i = filters.begin(); i != filters.end(); i++)
621 if (i->freeform == freeform)
623 return std::make_pair(false, "Filter already exists");
629 filters.push_back(FilterResult(RegexEngine, freeform, reason, type, duration, flgs));
631 catch (ModuleException &e)
633 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Error in regular expression '%s': %s", freeform.c_str(), e.GetReason().c_str());
634 return std::make_pair(false, e.GetReason());
636 return std::make_pair(true, "");
639 bool ModuleFilter::StringToFilterAction(const std::string& str, FilterAction& fa)
641 if (stdalgo::string::equalsci(str, "gline"))
643 else if (stdalgo::string::equalsci(str, "block"))
645 else if (stdalgo::string::equalsci(str, "silent"))
647 else if (stdalgo::string::equalsci(str, "kill"))
649 else if (stdalgo::string::equalsci(str, "none"))
657 std::string ModuleFilter::FilterActionToString(FilterAction fa)
661 case FA_GLINE: return "gline";
662 case FA_BLOCK: return "block";
663 case FA_SILENT: return "silent";
664 case FA_KILL: return "kill";
665 default: return "none";
669 void ModuleFilter::ReadFilters()
671 ConfigTagList tags = ServerInstance->Config->ConfTags("keyword");
672 for (ConfigIter i = tags.first; i != tags.second; ++i)
674 std::string pattern = i->second->getString("pattern");
675 this->DeleteFilter(pattern);
677 std::string reason = i->second->getString("reason");
678 std::string action = i->second->getString("action");
679 std::string flgs = i->second->getString("flags");
680 unsigned long gline_time = i->second->getDuration("duration", 10*60, 1);
685 if (!StringToFilterAction(action, fa))
690 filters.push_back(FilterResult(RegexEngine, pattern, reason, fa, gline_time, flgs));
691 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Regular expression %s loaded.", pattern.c_str());
693 catch (ModuleException &e)
695 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Error in regular expression '%s': %s", pattern.c_str(), e.GetReason().c_str());
700 ModResult ModuleFilter::OnStats(Stats::Context& stats)
702 if (stats.GetSymbol() == 's')
704 for (std::vector<FilterResult>::iterator i = filters.begin(); i != filters.end(); i++)
706 stats.AddRow(223, RegexEngine.GetProvider()+":"+i->freeform+" "+i->GetFlags()+" "+FilterActionToString(i->action)+" "+ConvToStr(i->gline_time)+" :"+i->reason);
708 for (ExemptTargetSet::const_iterator i = exemptedchans.begin(); i != exemptedchans.end(); ++i)
710 stats.AddRow(223, "EXEMPT "+(*i));
712 for (ExemptTargetSet::const_iterator i = exemptednicks.begin(); i != exemptednicks.end(); ++i)
714 stats.AddRow(223, "EXEMPT "+(*i));
717 return MOD_RES_PASSTHRU;
720 void ModuleFilter::OnUnloadModule(Module* mod)
722 // If the regex engine became unavailable or has changed, remove all filters
727 else if (RegexEngine.operator->() != factory)
729 factory = RegexEngine.operator->();
734 MODULE_INIT(ModuleFilter)