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"
54 bool flag_part_message;
55 bool flag_quit_message;
58 bool flag_strip_color;
60 FilterResult(dynamic_reference<RegexFactory>& RegexEngine, const std::string& free, const std::string& rea, FilterAction act, long gt, const std::string& fla)
61 : freeform(free), reason(rea), action(act), gline_time(gt)
64 throw ModuleException("Regex module implementing '"+RegexEngine.GetProvider()+"' is not loaded!");
65 regex = RegexEngine->Create(free);
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 ModuleFilter : public Module
159 typedef insp::flat_set<std::string, irc::insensitive_swo> ExemptTargetSet;
162 RegexFactory* factory;
166 CommandFilter filtcommand;
167 dynamic_reference<RegexFactory> RegexEngine;
169 std::vector<FilterResult> filters;
172 // List of channel names excluded from filtering.
173 ExemptTargetSet exemptedchans;
175 // List of target nicknames excluded from filtering.
176 ExemptTargetSet exemptednicks;
180 ModResult OnUserPreMessage(User* user, void* dest, int target_type, std::string& text, char status, CUList& exempt_list, MessageType msgtype) CXX11_OVERRIDE;
181 FilterResult* FilterMatch(User* user, const std::string &text, int flags);
182 bool DeleteFilter(const std::string &freeform);
183 std::pair<bool, std::string> AddFilter(const std::string &freeform, FilterAction type, const std::string &reason, long duration, const std::string &flags);
184 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE;
185 Version GetVersion() CXX11_OVERRIDE;
186 std::string EncodeFilter(FilterResult* filter);
187 FilterResult DecodeFilter(const std::string &data);
188 void OnSyncNetwork(ProtocolInterface::Server& server) CXX11_OVERRIDE;
189 void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata) CXX11_OVERRIDE;
190 ModResult OnStats(Stats::Context& stats) CXX11_OVERRIDE;
191 ModResult OnPreCommand(std::string &command, std::vector<std::string> ¶meters, LocalUser *user, bool validated, const std::string &original_line) CXX11_OVERRIDE;
192 void OnUnloadModule(Module* mod) CXX11_OVERRIDE;
193 bool AppliesToMe(User* user, FilterResult* filter, int flags);
195 static bool StringToFilterAction(const std::string& str, FilterAction& fa);
196 static std::string FilterActionToString(FilterAction fa);
199 CmdResult CommandFilter::Handle(const std::vector<std::string> ¶meters, User *user)
201 if (parameters.size() == 1)
203 /* Deleting a filter */
204 Module *me = creator;
205 if (static_cast<ModuleFilter *>(me)->DeleteFilter(parameters[0]))
207 user->WriteNotice("*** Removed filter '" + parameters[0] + "'");
208 ServerInstance->SNO->WriteToSnoMask(IS_LOCAL(user) ? 'a' : 'A', "FILTER: "+user->nick+" removed filter '"+parameters[0]+"'");
213 user->WriteNotice("*** Filter '" + parameters[0] + "' not found in list, try /stats s.");
219 /* Adding a filter */
220 if (parameters.size() >= 4)
222 const std::string& freeform = parameters[0];
224 const std::string& flags = parameters[2];
225 unsigned int reasonindex;
228 if (!ModuleFilter::StringToFilterAction(parameters[1], type))
230 user->WriteNotice("*** Invalid filter type '" + parameters[1] + "'. Supported types are 'gline', 'none', 'block', 'silent' and 'kill'.");
234 if (type == FA_GLINE)
236 if (parameters.size() >= 5)
238 duration = InspIRCd::Duration(parameters[3]);
243 user->WriteNotice("*** Not enough parameters: When setting a gline type filter, a gline duration must be specified as the third parameter.");
252 Module *me = creator;
253 std::pair<bool, std::string> result = static_cast<ModuleFilter *>(me)->AddFilter(freeform, type, parameters[reasonindex], duration, flags);
256 user->WriteNotice("*** Added filter '" + freeform + "', type '" + parameters[1] + "'" +
257 (duration ? ", duration " + parameters[3] : "") + ", flags '" + flags + "', reason: '" +
258 parameters[reasonindex] + "'");
260 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]);
266 user->WriteNotice("*** Filter '" + freeform + "' could not be added: " + result.second);
272 user->WriteNotice("*** Not enough parameters.");
279 bool ModuleFilter::AppliesToMe(User* user, FilterResult* filter, int iflags)
281 if ((filter->flag_no_opers) && user->IsOper())
283 if ((iflags & FLAG_PRIVMSG) && (!filter->flag_privmsg))
285 if ((iflags & FLAG_NOTICE) && (!filter->flag_notice))
287 if ((iflags & FLAG_QUIT) && (!filter->flag_quit_message))
289 if ((iflags & FLAG_PART) && (!filter->flag_part_message))
294 ModuleFilter::ModuleFilter()
295 : initing(true), filtcommand(this), RegexEngine(this, "regex")
299 CullResult ModuleFilter::cull()
302 return Module::cull();
305 void ModuleFilter::FreeFilters()
307 for (std::vector<FilterResult>::const_iterator i = filters.begin(); i != filters.end(); ++i)
313 ModResult ModuleFilter::OnUserPreMessage(User* user, void* dest, int target_type, std::string& text, char status, CUList& exempt_list, MessageType msgtype)
315 // Leave remote users and servers alone
317 return MOD_RES_PASSTHRU;
319 flags = (msgtype == MSG_PRIVMSG) ? FLAG_PRIVMSG : FLAG_NOTICE;
321 FilterResult* f = this->FilterMatch(user, text, flags);
325 if (target_type == TYPE_USER)
327 User* t = (User*)dest;
328 // Check if the target nick is exempted, if yes, ignore this message
329 if (exemptednicks.count(t->nick))
330 return MOD_RES_PASSTHRU;
334 else if (target_type == TYPE_CHANNEL)
336 Channel* t = (Channel*)dest;
337 if (exemptedchans.count(t->name))
338 return MOD_RES_PASSTHRU;
342 if (f->action == FA_BLOCK)
344 ServerInstance->SNO->WriteGlobalSno('a', "FILTER: "+user->nick+" had their message filtered, target was "+target+": "+f->reason);
345 if (target_type == TYPE_CHANNEL)
346 user->WriteNumeric(ERR_CANNOTSENDTOCHAN, target, InspIRCd::Format("Message to channel blocked and opers notified (%s)", f->reason.c_str()));
348 user->WriteNotice("Your message to "+target+" was blocked and opers notified: "+f->reason);
350 else if (f->action == FA_SILENT)
352 if (target_type == TYPE_CHANNEL)
353 user->WriteNumeric(ERR_CANNOTSENDTOCHAN, target, InspIRCd::Format("Message to channel blocked (%s)", f->reason.c_str()));
355 user->WriteNotice("Your message to "+target+" was blocked: "+f->reason);
357 else if (f->action == FA_KILL)
359 ServerInstance->Users->QuitUser(user, "Filtered: " + f->reason);
361 else if (f->action == FA_GLINE)
363 GLine* gl = new GLine(ServerInstance->Time(), f->gline_time, ServerInstance->Config->ServerName.c_str(), f->reason.c_str(), "*", user->GetIPString());
364 if (ServerInstance->XLines->AddLine(gl,NULL))
366 ServerInstance->XLines->ApplyLines();
372 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, user->nick + " had their message filtered, target was " + target + ": " + f->reason + " Action: " + ModuleFilter::FilterActionToString(f->action));
375 return MOD_RES_PASSTHRU;
378 ModResult ModuleFilter::OnPreCommand(std::string &command, std::vector<std::string> ¶meters, LocalUser *user, bool validated, const std::string &original_line)
385 if (command == "QUIT")
387 /* QUIT with no reason: nothing to do */
388 if (parameters.size() < 1)
389 return MOD_RES_PASSTHRU;
394 else if (command == "PART")
396 /* PART with no reason: nothing to do */
397 if (parameters.size() < 2)
398 return MOD_RES_PASSTHRU;
400 if (exemptedchans.count(parameters[0]))
401 return MOD_RES_PASSTHRU;
407 /* We're only messing with PART and QUIT */
408 return MOD_RES_PASSTHRU;
410 FilterResult* f = this->FilterMatch(user, parameters[parting ? 1 : 0], flags);
412 /* PART or QUIT reason doesnt match a filter */
413 return MOD_RES_PASSTHRU;
415 /* We cant block a part or quit, so instead we change the reason to 'Reason filtered' */
416 parameters[parting ? 1 : 0] = "Reason filtered";
418 /* We're blocking, OR theyre quitting and its a KILL action
419 * (we cant kill someone whos already quitting, so filter them anyway)
421 if ((f->action == FA_BLOCK) || (((!parting) && (f->action == FA_KILL))) || (f->action == FA_SILENT))
423 return MOD_RES_PASSTHRU;
427 /* Are they parting, if so, kill is applicable */
428 if ((parting) && (f->action == FA_KILL))
430 user->WriteNotice("*** Your PART message was filtered: " + f->reason);
431 ServerInstance->Users->QuitUser(user, "Filtered: " + f->reason);
433 if (f->action == FA_GLINE)
435 /* Note: We gline *@IP so that if their host doesnt resolve the gline still applies. */
436 GLine* gl = new GLine(ServerInstance->Time(), f->gline_time, ServerInstance->Config->ServerName.c_str(), f->reason.c_str(), "*", user->GetIPString());
437 if (ServerInstance->XLines->AddLine(gl,NULL))
439 ServerInstance->XLines->ApplyLines();
447 return MOD_RES_PASSTHRU;
450 void ModuleFilter::ReadConfig(ConfigStatus& status)
452 ConfigTagList tags = ServerInstance->Config->ConfTags("exemptfromfilter");
453 exemptedchans.clear();
454 exemptednicks.clear();
456 for (ConfigIter i = tags.first; i != tags.second; ++i)
458 ConfigTag* tag = i->second;
460 // If "target" is not found, try the old "channel" key to keep compatibility with 2.0 configs
461 const std::string target = tag->getString("target", tag->getString("channel"));
464 if (target[0] == '#')
465 exemptedchans.insert(target);
467 exemptednicks.insert(target);
471 std::string newrxengine = ServerInstance->Config->ConfValue("filteropts")->getString("engine");
473 factory = RegexEngine ? (RegexEngine.operator->()) : NULL;
475 if (newrxengine.empty())
476 RegexEngine.SetProvider("regex");
478 RegexEngine.SetProvider("regex/" + newrxengine);
482 if (newrxengine.empty())
483 ServerInstance->SNO->WriteGlobalSno('a', "WARNING: No regex engine loaded - Filter functionality disabled until this is corrected.");
485 ServerInstance->SNO->WriteGlobalSno('a', "WARNING: Regex engine '%s' is not loaded - Filter functionality disabled until this is corrected.", newrxengine.c_str());
492 if ((!initing) && (RegexEngine.operator->() != factory))
494 ServerInstance->SNO->WriteGlobalSno('a', "Dumping all filters due to regex engine change");
502 Version ModuleFilter::GetVersion()
504 return Version("Text (spam) filtering", VF_VENDOR | VF_COMMON, RegexEngine ? RegexEngine->name : "");
507 std::string ModuleFilter::EncodeFilter(FilterResult* filter)
509 std::ostringstream stream;
510 std::string x = filter->freeform;
512 /* Hax to allow spaces in the freeform without changing the design of the irc protocol */
513 for (std::string::iterator n = x.begin(); n != x.end(); n++)
517 stream << x << " " << FilterActionToString(filter->action) << " " << filter->GetFlags() << " " << filter->gline_time << " :" << filter->reason;
521 FilterResult ModuleFilter::DecodeFilter(const std::string &data)
523 std::string filteraction;
525 irc::tokenstream tokens(data);
526 tokens.GetToken(res.freeform);
527 tokens.GetToken(filteraction);
528 if (!StringToFilterAction(filteraction, res.action))
529 throw ModuleException("Invalid action: " + filteraction);
531 std::string filterflags;
532 tokens.GetToken(filterflags);
533 char c = res.FillFlags(filterflags);
535 throw ModuleException("Invalid flag: '" + std::string(1, c) + "'");
537 tokens.GetToken(res.gline_time);
538 tokens.GetToken(res.reason);
540 /* Hax to allow spaces in the freeform without changing the design of the irc protocol */
541 for (std::string::iterator n = res.freeform.begin(); n != res.freeform.end(); n++)
548 void ModuleFilter::OnSyncNetwork(ProtocolInterface::Server& server)
550 for (std::vector<FilterResult>::iterator i = filters.begin(); i != filters.end(); ++i)
552 server.SendMetaData("filter", EncodeFilter(&(*i)));
556 void ModuleFilter::OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata)
558 if ((target == NULL) && (extname == "filter"))
562 FilterResult data = DecodeFilter(extdata);
563 this->AddFilter(data.freeform, data.action, data.reason, data.gline_time, data.GetFlags());
565 catch (ModuleException& e)
567 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Error when unserializing filter: " + e.GetReason());
572 FilterResult* ModuleFilter::FilterMatch(User* user, const std::string &text, int flgs)
574 static std::string stripped_text;
575 stripped_text.clear();
577 for (std::vector<FilterResult>::iterator i = filters.begin(); i != filters.end(); ++i)
579 FilterResult* filter = &*i;
581 /* Skip ones that dont apply to us */
582 if (!AppliesToMe(user, filter, flgs))
585 if ((filter->flag_strip_color) && (stripped_text.empty()))
587 stripped_text = text;
588 InspIRCd::StripColor(stripped_text);
591 if (filter->regex->Matches(filter->flag_strip_color ? stripped_text : text))
597 bool ModuleFilter::DeleteFilter(const std::string &freeform)
599 for (std::vector<FilterResult>::iterator i = filters.begin(); i != filters.end(); i++)
601 if (i->freeform == freeform)
611 std::pair<bool, std::string> ModuleFilter::AddFilter(const std::string &freeform, FilterAction type, const std::string &reason, long duration, const std::string &flgs)
613 for (std::vector<FilterResult>::iterator i = filters.begin(); i != filters.end(); i++)
615 if (i->freeform == freeform)
617 return std::make_pair(false, "Filter already exists");
623 filters.push_back(FilterResult(RegexEngine, freeform, reason, type, duration, flgs));
625 catch (ModuleException &e)
627 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Error in regular expression '%s': %s", freeform.c_str(), e.GetReason().c_str());
628 return std::make_pair(false, e.GetReason());
630 return std::make_pair(true, "");
633 bool ModuleFilter::StringToFilterAction(const std::string& str, FilterAction& fa)
635 irc::string s(str.c_str());
639 else if (s == "block")
641 else if (s == "silent")
643 else if (s == "kill")
645 else if (s == "none")
653 std::string ModuleFilter::FilterActionToString(FilterAction fa)
657 case FA_GLINE: return "gline";
658 case FA_BLOCK: return "block";
659 case FA_SILENT: return "silent";
660 case FA_KILL: return "kill";
661 default: return "none";
665 void ModuleFilter::ReadFilters()
667 ConfigTagList tags = ServerInstance->Config->ConfTags("keyword");
668 for (ConfigIter i = tags.first; i != tags.second; ++i)
670 std::string pattern = i->second->getString("pattern");
671 this->DeleteFilter(pattern);
673 std::string reason = i->second->getString("reason");
674 std::string action = i->second->getString("action");
675 std::string flgs = i->second->getString("flags");
676 unsigned long gline_time = i->second->getDuration("duration", 10*60, 1);
681 if (!StringToFilterAction(action, fa))
686 filters.push_back(FilterResult(RegexEngine, pattern, reason, fa, gline_time, flgs));
687 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Regular expression %s loaded.", pattern.c_str());
689 catch (ModuleException &e)
691 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Error in regular expression '%s': %s", pattern.c_str(), e.GetReason().c_str());
696 ModResult ModuleFilter::OnStats(Stats::Context& stats)
698 if (stats.GetSymbol() == 's')
700 for (std::vector<FilterResult>::iterator i = filters.begin(); i != filters.end(); i++)
702 stats.AddRow(223, RegexEngine.GetProvider()+":"+i->freeform+" "+i->GetFlags()+" "+FilterActionToString(i->action)+" "+ConvToStr(i->gline_time)+" :"+i->reason);
704 for (ExemptTargetSet::const_iterator i = exemptedchans.begin(); i != exemptedchans.end(); ++i)
706 stats.AddRow(223, "EXEMPT "+(*i));
708 for (ExemptTargetSet::const_iterator i = exemptednicks.begin(); i != exemptednicks.end(); ++i)
710 stats.AddRow(223, "EXEMPT "+(*i));
713 return MOD_RES_PASSTHRU;
716 void ModuleFilter::OnUnloadModule(Module* mod)
718 // If the regex engine became unavailable or has changed, remove all filters
723 else if (RegexEngine.operator->() != factory)
725 factory = RegexEngine.operator->();
730 MODULE_INIT(ModuleFilter)