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
160 RegexFactory* factory;
164 CommandFilter filtcommand;
165 dynamic_reference<RegexFactory> RegexEngine;
167 std::vector<FilterResult> filters;
170 std::set<std::string> exemptfromfilter; // List of channel names excluded from filtering.
174 ModResult OnUserPreMessage(User* user, void* dest, int target_type, std::string& text, char status, CUList& exempt_list, MessageType msgtype) CXX11_OVERRIDE;
175 FilterResult* FilterMatch(User* user, const std::string &text, int flags);
176 bool DeleteFilter(const std::string &freeform);
177 std::pair<bool, std::string> AddFilter(const std::string &freeform, FilterAction type, const std::string &reason, long duration, const std::string &flags);
178 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE;
179 Version GetVersion() CXX11_OVERRIDE;
180 std::string EncodeFilter(FilterResult* filter);
181 FilterResult DecodeFilter(const std::string &data);
182 void OnSyncNetwork(ProtocolInterface::Server& server) CXX11_OVERRIDE;
183 void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata) CXX11_OVERRIDE;
184 ModResult OnStats(char symbol, User* user, string_list &results) CXX11_OVERRIDE;
185 ModResult OnPreCommand(std::string &command, std::vector<std::string> ¶meters, LocalUser *user, bool validated, const std::string &original_line) CXX11_OVERRIDE;
186 void OnUnloadModule(Module* mod) CXX11_OVERRIDE;
187 bool AppliesToMe(User* user, FilterResult* filter, int flags);
189 static bool StringToFilterAction(const std::string& str, FilterAction& fa);
190 static std::string FilterActionToString(FilterAction fa);
193 CmdResult CommandFilter::Handle(const std::vector<std::string> ¶meters, User *user)
195 if (parameters.size() == 1)
197 /* Deleting a filter */
198 Module *me = creator;
199 if (static_cast<ModuleFilter *>(me)->DeleteFilter(parameters[0]))
201 user->WriteNotice("*** Removed filter '" + parameters[0] + "'");
202 ServerInstance->SNO->WriteToSnoMask(IS_LOCAL(user) ? 'a' : 'A', "FILTER: "+user->nick+" removed filter '"+parameters[0]+"'");
207 user->WriteNotice("*** Filter '" + parameters[0] + "' not found in list, try /stats s.");
213 /* Adding a filter */
214 if (parameters.size() >= 4)
216 const std::string& freeform = parameters[0];
218 const std::string& flags = parameters[2];
219 unsigned int reasonindex;
222 if (!ModuleFilter::StringToFilterAction(parameters[1], type))
224 user->WriteNotice("*** Invalid filter type '" + parameters[1] + "'. Supported types are 'gline', 'none', 'block', 'silent' and 'kill'.");
228 if (type == FA_GLINE)
230 if (parameters.size() >= 5)
232 duration = InspIRCd::Duration(parameters[3]);
237 user->WriteNotice("*** Not enough parameters: When setting a gline type filter, a gline duration must be specified as the third parameter.");
246 Module *me = creator;
247 std::pair<bool, std::string> result = static_cast<ModuleFilter *>(me)->AddFilter(freeform, type, parameters[reasonindex], duration, flags);
250 user->WriteNotice("*** Added filter '" + freeform + "', type '" + parameters[1] + "'" +
251 (duration ? ", duration " + parameters[3] : "") + ", flags '" + flags + "', reason: '" +
252 parameters[reasonindex] + "'");
254 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]);
260 user->WriteNotice("*** Filter '" + freeform + "' could not be added: " + result.second);
266 user->WriteNotice("*** Not enough parameters.");
273 bool ModuleFilter::AppliesToMe(User* user, FilterResult* filter, int iflags)
275 if ((filter->flag_no_opers) && user->IsOper())
277 if ((iflags & FLAG_PRIVMSG) && (!filter->flag_privmsg))
279 if ((iflags & FLAG_NOTICE) && (!filter->flag_notice))
281 if ((iflags & FLAG_QUIT) && (!filter->flag_quit_message))
283 if ((iflags & FLAG_PART) && (!filter->flag_part_message))
288 ModuleFilter::ModuleFilter()
289 : initing(true), filtcommand(this), RegexEngine(this, "regex")
293 CullResult ModuleFilter::cull()
296 return Module::cull();
299 void ModuleFilter::FreeFilters()
301 for (std::vector<FilterResult>::const_iterator i = filters.begin(); i != filters.end(); ++i)
307 ModResult ModuleFilter::OnUserPreMessage(User* user, void* dest, int target_type, std::string& text, char status, CUList& exempt_list, MessageType msgtype)
309 // Leave remote users and servers alone
311 return MOD_RES_PASSTHRU;
313 flags = (msgtype == MSG_PRIVMSG) ? FLAG_PRIVMSG : FLAG_NOTICE;
315 FilterResult* f = this->FilterMatch(user, text, flags);
319 if (target_type == TYPE_USER)
321 User* t = (User*)dest;
324 else if (target_type == TYPE_CHANNEL)
326 Channel* t = (Channel*)dest;
327 if (exemptfromfilter.find(t->name) != exemptfromfilter.end())
328 return MOD_RES_PASSTHRU;
332 if (f->action == FA_BLOCK)
334 ServerInstance->SNO->WriteGlobalSno('a', "FILTER: "+user->nick+" had their message filtered, target was "+target+": "+f->reason);
335 if (target_type == TYPE_CHANNEL)
336 user->WriteNumeric(ERR_CANNOTSENDTOCHAN, "%s :Message to channel blocked and opers notified (%s)", target.c_str(), f->reason.c_str());
338 user->WriteNotice("Your message to "+target+" was blocked and opers notified: "+f->reason);
340 else if (f->action == FA_SILENT)
342 if (target_type == TYPE_CHANNEL)
343 user->WriteNumeric(ERR_CANNOTSENDTOCHAN, "%s :Message to channel blocked (%s)", target.c_str(), f->reason.c_str());
345 user->WriteNotice("Your message to "+target+" was blocked: "+f->reason);
347 else if (f->action == FA_KILL)
349 ServerInstance->Users->QuitUser(user, "Filtered: " + f->reason);
351 else if (f->action == FA_GLINE)
353 GLine* gl = new GLine(ServerInstance->Time(), f->gline_time, ServerInstance->Config->ServerName.c_str(), f->reason.c_str(), "*", user->GetIPString());
354 if (ServerInstance->XLines->AddLine(gl,NULL))
356 ServerInstance->XLines->ApplyLines();
362 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, user->nick + " had their message filtered, target was " + target + ": " + f->reason + " Action: " + ModuleFilter::FilterActionToString(f->action));
365 return MOD_RES_PASSTHRU;
368 ModResult ModuleFilter::OnPreCommand(std::string &command, std::vector<std::string> ¶meters, LocalUser *user, bool validated, const std::string &original_line)
370 if (validated && IS_LOCAL(user))
375 if (command == "QUIT")
377 /* QUIT with no reason: nothing to do */
378 if (parameters.size() < 1)
379 return MOD_RES_PASSTHRU;
384 else if (command == "PART")
386 /* PART with no reason: nothing to do */
387 if (parameters.size() < 2)
388 return MOD_RES_PASSTHRU;
390 if (exemptfromfilter.find(parameters[0]) != exemptfromfilter.end())
391 return MOD_RES_PASSTHRU;
397 /* We're only messing with PART and QUIT */
398 return MOD_RES_PASSTHRU;
400 FilterResult* f = this->FilterMatch(user, parameters[parting ? 1 : 0], flags);
402 /* PART or QUIT reason doesnt match a filter */
403 return MOD_RES_PASSTHRU;
405 /* We cant block a part or quit, so instead we change the reason to 'Reason filtered' */
406 parameters[parting ? 1 : 0] = "Reason filtered";
408 /* We're blocking, OR theyre quitting and its a KILL action
409 * (we cant kill someone whos already quitting, so filter them anyway)
411 if ((f->action == FA_BLOCK) || (((!parting) && (f->action == FA_KILL))) || (f->action == FA_SILENT))
413 return MOD_RES_PASSTHRU;
417 /* Are they parting, if so, kill is applicable */
418 if ((parting) && (f->action == FA_KILL))
420 user->WriteNotice("*** Your PART message was filtered: " + f->reason);
421 ServerInstance->Users->QuitUser(user, "Filtered: " + f->reason);
423 if (f->action == FA_GLINE)
425 /* Note: We gline *@IP so that if their host doesnt resolve the gline still applies. */
426 GLine* gl = new GLine(ServerInstance->Time(), f->gline_time, ServerInstance->Config->ServerName.c_str(), f->reason.c_str(), "*", user->GetIPString());
427 if (ServerInstance->XLines->AddLine(gl,NULL))
429 ServerInstance->XLines->ApplyLines();
437 return MOD_RES_PASSTHRU;
440 void ModuleFilter::ReadConfig(ConfigStatus& status)
442 ConfigTagList tags = ServerInstance->Config->ConfTags("exemptfromfilter");
443 exemptfromfilter.clear();
444 for (ConfigIter i = tags.first; i != tags.second; ++i)
446 std::string chan = i->second->getString("channel");
448 exemptfromfilter.insert(chan);
451 std::string newrxengine = ServerInstance->Config->ConfValue("filteropts")->getString("engine");
453 factory = RegexEngine ? (RegexEngine.operator->()) : NULL;
455 if (newrxengine.empty())
456 RegexEngine.SetProvider("regex");
458 RegexEngine.SetProvider("regex/" + newrxengine);
462 if (newrxengine.empty())
463 ServerInstance->SNO->WriteGlobalSno('a', "WARNING: No regex engine loaded - Filter functionality disabled until this is corrected.");
465 ServerInstance->SNO->WriteGlobalSno('a', "WARNING: Regex engine '%s' is not loaded - Filter functionality disabled until this is corrected.", newrxengine.c_str());
472 if ((!initing) && (RegexEngine.operator->() != factory))
474 ServerInstance->SNO->WriteGlobalSno('a', "Dumping all filters due to regex engine change");
482 Version ModuleFilter::GetVersion()
484 return Version("Text (spam) filtering", VF_VENDOR | VF_COMMON, RegexEngine ? RegexEngine->name : "");
487 std::string ModuleFilter::EncodeFilter(FilterResult* filter)
489 std::ostringstream stream;
490 std::string x = filter->freeform;
492 /* Hax to allow spaces in the freeform without changing the design of the irc protocol */
493 for (std::string::iterator n = x.begin(); n != x.end(); n++)
497 stream << x << " " << FilterActionToString(filter->action) << " " << filter->GetFlags() << " " << filter->gline_time << " :" << filter->reason;
501 FilterResult ModuleFilter::DecodeFilter(const std::string &data)
503 std::string filteraction;
505 irc::tokenstream tokens(data);
506 tokens.GetToken(res.freeform);
507 tokens.GetToken(filteraction);
508 if (!StringToFilterAction(filteraction, res.action))
509 throw ModuleException("Invalid action: " + filteraction);
511 std::string filterflags;
512 tokens.GetToken(filterflags);
513 char c = res.FillFlags(filterflags);
515 throw ModuleException("Invalid flag: '" + std::string(1, c) + "'");
517 tokens.GetToken(res.gline_time);
518 tokens.GetToken(res.reason);
520 /* Hax to allow spaces in the freeform without changing the design of the irc protocol */
521 for (std::string::iterator n = res.freeform.begin(); n != res.freeform.end(); n++)
528 void ModuleFilter::OnSyncNetwork(ProtocolInterface::Server& server)
530 for (std::vector<FilterResult>::iterator i = filters.begin(); i != filters.end(); ++i)
532 server.SendMetaData("filter", EncodeFilter(&(*i)));
536 void ModuleFilter::OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata)
538 if ((target == NULL) && (extname == "filter"))
542 FilterResult data = DecodeFilter(extdata);
543 this->AddFilter(data.freeform, data.action, data.reason, data.gline_time, data.GetFlags());
545 catch (ModuleException& e)
547 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Error when unserializing filter: " + e.GetReason());
552 FilterResult* ModuleFilter::FilterMatch(User* user, const std::string &text, int flgs)
554 static std::string stripped_text;
555 stripped_text.clear();
557 for (std::vector<FilterResult>::iterator i = filters.begin(); i != filters.end(); ++i)
559 FilterResult* filter = &*i;
561 /* Skip ones that dont apply to us */
562 if (!AppliesToMe(user, filter, flgs))
565 if ((filter->flag_strip_color) && (stripped_text.empty()))
567 stripped_text = text;
568 InspIRCd::StripColor(stripped_text);
571 if (filter->regex->Matches(filter->flag_strip_color ? stripped_text : text))
577 bool ModuleFilter::DeleteFilter(const std::string &freeform)
579 for (std::vector<FilterResult>::iterator i = filters.begin(); i != filters.end(); i++)
581 if (i->freeform == freeform)
591 std::pair<bool, std::string> ModuleFilter::AddFilter(const std::string &freeform, FilterAction type, const std::string &reason, long duration, const std::string &flgs)
593 for (std::vector<FilterResult>::iterator i = filters.begin(); i != filters.end(); i++)
595 if (i->freeform == freeform)
597 return std::make_pair(false, "Filter already exists");
603 filters.push_back(FilterResult(RegexEngine, freeform, reason, type, duration, flgs));
605 catch (ModuleException &e)
607 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Error in regular expression '%s': %s", freeform.c_str(), e.GetReason().c_str());
608 return std::make_pair(false, e.GetReason());
610 return std::make_pair(true, "");
613 bool ModuleFilter::StringToFilterAction(const std::string& str, FilterAction& fa)
615 irc::string s(str.c_str());
619 else if (s == "block")
621 else if (s == "silent")
623 else if (s == "kill")
625 else if (s == "none")
633 std::string ModuleFilter::FilterActionToString(FilterAction fa)
637 case FA_GLINE: return "gline";
638 case FA_BLOCK: return "block";
639 case FA_SILENT: return "silent";
640 case FA_KILL: return "kill";
641 default: return "none";
645 void ModuleFilter::ReadFilters()
647 ConfigTagList tags = ServerInstance->Config->ConfTags("keyword");
648 for (ConfigIter i = tags.first; i != tags.second; ++i)
650 std::string pattern = i->second->getString("pattern");
651 this->DeleteFilter(pattern);
653 std::string reason = i->second->getString("reason");
654 std::string action = i->second->getString("action");
655 std::string flgs = i->second->getString("flags");
656 unsigned long gline_time = i->second->getDuration("duration", 10*60, 1);
661 if (!StringToFilterAction(action, fa))
666 filters.push_back(FilterResult(RegexEngine, pattern, reason, fa, gline_time, flgs));
667 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Regular expression %s loaded.", pattern.c_str());
669 catch (ModuleException &e)
671 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Error in regular expression '%s': %s", pattern.c_str(), e.GetReason().c_str());
676 ModResult ModuleFilter::OnStats(char symbol, User* user, string_list &results)
680 for (std::vector<FilterResult>::iterator i = filters.begin(); i != filters.end(); i++)
682 results.push_back("223 "+user->nick+" :"+RegexEngine.GetProvider()+":"+i->freeform+" "+i->GetFlags()+" "+FilterActionToString(i->action)+" "+ConvToStr(i->gline_time)+" :"+i->reason);
684 for (std::set<std::string>::iterator i = exemptfromfilter.begin(); i != exemptfromfilter.end(); ++i)
686 results.push_back("223 "+user->nick+" :EXEMPT "+(*i));
689 return MOD_RES_PASSTHRU;
692 void ModuleFilter::OnUnloadModule(Module* mod)
694 // If the regex engine became unavailable or has changed, remove all filters
699 else if (RegexEngine.operator->() != factory)
701 factory = RegexEngine.operator->();
706 MODULE_INIT(ModuleFilter)