1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/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 FilterBase : public Module
102 CommandFilter* filtcommand;
105 std::vector<std::string> exemptfromfilter; // List of channel names excluded from filtering.
107 FilterBase(InspIRCd* Me, const std::string &source);
108 virtual ~FilterBase();
109 virtual int OnUserPreMessage(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list);
110 virtual FilterResult* FilterMatch(User* user, const std::string &text, int flags) = 0;
111 virtual bool DeleteFilter(const std::string &freeform) = 0;
112 virtual void SyncFilters(Module* proto, void* opaque) = 0;
113 virtual void SendFilter(Module* proto, void* opaque, FilterResult* iter);
114 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;
115 virtual int OnUserPreNotice(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list);
116 virtual void OnRehash(User* user, const std::string ¶meter);
117 virtual Version GetVersion();
118 std::string EncodeFilter(FilterResult* filter);
119 FilterResult DecodeFilter(const std::string &data);
120 virtual void OnSyncOtherMetaData(Module* proto, void* opaque, bool displayable = false);
121 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
122 virtual int OnStats(char symbol, User* user, string_list &results) = 0;
123 virtual int OnPreCommand(std::string &command, std::vector<std::string> ¶meters, User *user, bool validated, const std::string &original_line);
124 bool AppliesToMe(User* user, FilterResult* filter, int flags);
125 void OnLoadModule(Module* mod, const std::string& name);
126 virtual void ReadFilters(ConfigReader &MyConf) = 0;
129 class CommandFilter : public Command
133 CommandFilter(FilterBase* f, InspIRCd* Me, const std::string &ssource) : Command(Me, "FILTER", "o", 1, 5), Base(f)
135 this->source = ssource;
136 this->syntax = "<filter-definition> <action> <flags> [<gline-duration>] :<reason>";
139 CmdResult Handle(const std::vector<std::string> ¶meters, User *user)
141 if (parameters.size() == 1)
143 /* Deleting a filter */
144 if (Base->DeleteFilter(parameters[0]))
146 user->WriteServ("NOTICE %s :*** Removed filter '%s'", user->nick.c_str(), parameters[0].c_str());
147 ServerInstance->SNO->WriteToSnoMask('A', std::string("FILTER: ")+user->nick+" removed filter '"+parameters[0]+"'");
152 user->WriteServ("NOTICE %s :*** Filter '%s' not found in list, try /stats s.", user->nick.c_str(), parameters[0].c_str());
158 /* Adding a filter */
159 if (parameters.size() >= 4)
161 std::string freeform = parameters[0];
162 std::string type = parameters[1];
163 std::string flags = parameters[2];
168 if ((type != "gline") && (type != "none") && (type != "block") && (type != "kill") && (type != "silent"))
170 user->WriteServ("NOTICE %s :*** Invalid filter type '%s'. Supported types are 'gline', 'none', 'block', 'silent' and 'kill'.", user->nick.c_str(), freeform.c_str());
176 if (parameters.size() >= 5)
178 duration = ServerInstance->Duration(parameters[3]);
179 reason = parameters[4];
183 this->TooFewParams(user, ": When setting a gline type filter, a gline duration must be specified as the third parameter.");
189 reason = parameters[3];
191 std::pair<bool, std::string> result = Base->AddFilter(freeform, type, reason, duration, flags);
194 user->WriteServ("NOTICE %s :*** Added filter '%s', type '%s'%s%s, flags '%s', reason: '%s'", user->nick.c_str(), freeform.c_str(),
195 type.c_str(), (duration ? ", duration " : ""), (duration ? parameters[3].c_str() : ""),
196 flags.c_str(), reason.c_str());
198 ServerInstance->SNO->WriteToSnoMask('A', std::string("FILTER: ")+user->nick+" added filter '"+freeform+"', type '"+type+"', "+(duration ? "duration "+parameters[3]+", " : "")+"flags '"+flags+"', reason: "+reason);
204 user->WriteServ("NOTICE %s :*** Filter '%s' could not be added: %s", user->nick.c_str(), freeform.c_str(), result.second.c_str());
210 this->TooFewParams(user, ".");
217 void TooFewParams(User* user, const std::string &extra_text)
219 user->WriteServ("NOTICE %s :*** Not enough parameters%s", user->nick.c_str(), extra_text.c_str());
223 bool FilterBase::AppliesToMe(User* user, FilterResult* filter, int iflags)
225 if ((filter->flag_no_opers) && IS_OPER(user))
227 if ((iflags & FLAG_PRIVMSG) && (!filter->flag_privmsg))
229 if ((iflags & FLAG_NOTICE) && (!filter->flag_notice))
231 if ((iflags & FLAG_QUIT) && (!filter->flag_quit_message))
233 if ((iflags & FLAG_PART) && (!filter->flag_part_message))
238 FilterBase::FilterBase(InspIRCd* Me, const std::string &source) : Module(Me)
240 Me->Modules->UseInterface("RegularExpression");
241 filtcommand = new CommandFilter(this, Me, source);
242 ServerInstance->AddCommand(filtcommand);
243 Implementation eventlist[] = { I_OnPreCommand, I_OnStats, I_OnSyncOtherMetaData, I_OnDecodeMetaData, I_OnUserPreMessage, I_OnUserPreNotice, I_OnRehash, I_OnLoadModule };
244 ServerInstance->Modules->Attach(eventlist, this, 8);
247 FilterBase::~FilterBase()
249 ServerInstance->Modules->DoneWithInterface("RegularExpression");
252 int FilterBase::OnUserPreMessage(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
254 flags = FLAG_PRIVMSG;
255 return OnUserPreNotice(user,dest,target_type,text,status,exempt_list);
258 int FilterBase::OnUserPreNotice(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
263 /* Leave ulines alone */
264 if ((ServerInstance->ULine(user->server)) || (!IS_LOCAL(user)))
267 FilterResult* f = this->FilterMatch(user, text, flags);
270 std::string target = "";
271 if (target_type == TYPE_USER)
273 User* t = (User*)dest;
274 target = std::string(t->nick);
276 else if (target_type == TYPE_CHANNEL)
278 Channel* t = (Channel*)dest;
279 target = std::string(t->name);
280 std::vector<std::string>::iterator i = find(exemptfromfilter.begin(), exemptfromfilter.end(), target);
281 if (i != exemptfromfilter.end()) return 0;
283 if (f->action == "block")
285 ServerInstance->SNO->WriteToSnoMask('A', std::string("FILTER: ")+user->nick+" had their message filtered, target was "+target+": "+f->reason);
286 user->WriteServ("NOTICE "+std::string(user->nick)+" :Your message has been filtered and opers notified: "+f->reason);
288 if (f->action == "silent")
290 user->WriteServ("NOTICE "+std::string(user->nick)+" :Your message has been filtered: "+f->reason);
292 if (f->action == "kill")
294 ServerInstance->Users->QuitUser(user, "Filtered: " + f->reason);
296 if (f->action == "gline")
298 GLine* gl = new GLine(ServerInstance, ServerInstance->Time(), f->gline_time, ServerInstance->Config->ServerName, f->reason.c_str(), "*", user->GetIPString());
299 if (ServerInstance->XLines->AddLine(gl,NULL))
301 ServerInstance->XLines->ApplyLines();
307 ServerInstance->Logs->Log("FILTER",DEFAULT,"FILTER: "+ user->nick + " had their message filtered, target was " + target + ": " + f->reason + " Action: " + f->action);
313 int FilterBase::OnPreCommand(std::string &command, std::vector<std::string> ¶meters, User *user, bool validated, const std::string &original_line)
316 if (validated && IS_LOCAL(user))
318 std::string checkline;
319 int replacepoint = 0;
320 bool parting = false;
322 if (command == "QUIT")
324 /* QUIT with no reason: nothing to do */
325 if (parameters.size() < 1)
328 checkline = parameters[0];
333 else if (command == "PART")
335 /* PART with no reason: nothing to do */
336 if (parameters.size() < 2)
339 std::vector<std::string>::iterator i = find(exemptfromfilter.begin(), exemptfromfilter.end(), parameters[0]);
340 if (i != exemptfromfilter.end()) return 0;
341 checkline = parameters[1];
347 /* We're only messing with PART and QUIT */
350 FilterResult* f = NULL;
353 f = this->FilterMatch(user, checkline, flags);
356 /* PART or QUIT reason doesnt match a filter */
359 /* We cant block a part or quit, so instead we change the reason to 'Reason filtered' */
360 Command* c = ServerInstance->Parser->GetHandler(command);
363 std::vector<std::string> params;
364 for (int item = 0; item < (int)parameters.size(); item++)
365 params.push_back(parameters[item]);
366 params[replacepoint] = "Reason filtered";
368 /* We're blocking, OR theyre quitting and its a KILL action
369 * (we cant kill someone whos already quitting, so filter them anyway)
371 if ((f->action == "block") || (((!parting) && (f->action == "kill"))) || (f->action == "silent"))
373 c->Handle(params, user);
378 /* Are they parting, if so, kill is applicable */
379 if ((parting) && (f->action == "kill"))
381 user->WriteServ("NOTICE %s :*** Your PART message was filtered: %s", user->nick.c_str(), f->reason.c_str());
382 ServerInstance->Users->QuitUser(user, "Filtered: " + f->reason);
384 if (f->action == "gline")
386 /* Note: We gline *@IP so that if their host doesnt resolve the gline still applies. */
387 GLine* gl = new GLine(ServerInstance, ServerInstance->Time(), f->gline_time, ServerInstance->Config->ServerName, f->reason.c_str(), "*", user->GetIPString());
388 if (ServerInstance->XLines->AddLine(gl,NULL))
390 ServerInstance->XLines->ApplyLines();
403 void FilterBase::OnRehash(User* user, const std::string ¶meter)
405 ConfigReader* MyConf = new ConfigReader(ServerInstance);
406 std::vector<std::string>().swap(exemptfromfilter);
407 for (int index = 0; index < MyConf->Enumerate("exemptfromfilter"); ++index)
409 std::string chan = MyConf->ReadValue("exemptfromfilter", "channel", index);
411 exemptfromfilter.push_back(chan);
414 std::string newrxengine = MyConf->ReadValue("filteropts", "engine", 0);
415 if (!RegexEngine.empty())
417 if (RegexEngine == newrxengine)
420 ServerInstance->SNO->WriteToSnoMask('A', "Dumping all filters due to regex engine change (was '%s', now '%s')", RegexEngine.c_str(), newrxengine.c_str());
421 //ServerInstance->XLines->DelAll("R");
425 RegexEngine = newrxengine;
426 modulelist* ml = ServerInstance->Modules->FindInterface("RegularExpression");
429 for (modulelist::iterator i = ml->begin(); i != ml->end(); ++i)
431 if (RegexNameRequest(this, *i).Send() == newrxengine)
433 ServerInstance->SNO->WriteToSnoMask('A', "Filter now using engine '%s'", RegexEngine.c_str());
440 ServerInstance->SNO->WriteToSnoMask('A', "WARNING: Regex engine '%s' is not loaded - Filter functionality disabled until this is corrected.", RegexEngine.c_str());
446 void FilterBase::OnLoadModule(Module* mod, const std::string& name)
448 if (ServerInstance->Modules->ModuleHasInterface(mod, "RegularExpression"))
450 std::string rxname = RegexNameRequest(this, mod).Send();
451 if (rxname == RegexEngine)
454 /* Force a rehash to make sure that any filters that couldnt be applied from the conf
455 * on startup or on load are applied right now.
457 ConfigReader Config(ServerInstance);
458 ServerInstance->SNO->WriteToSnoMask('A', "Found and activated regex module '%s' for m_filter.so.", RegexEngine.c_str());
465 Version FilterBase::GetVersion()
467 return Version("$Id$", VF_VENDOR | VF_COMMON, API_VERSION);
471 std::string FilterBase::EncodeFilter(FilterResult* filter)
473 std::ostringstream stream;
474 std::string x = filter->freeform;
476 /* Hax to allow spaces in the freeform without changing the design of the irc protocol */
477 for (std::string::iterator n = x.begin(); n != x.end(); n++)
481 stream << x << " " << filter->action << " " << (filter->flags.empty() ? "-" : filter->flags) << " " << filter->gline_time << " :" << filter->reason;
485 FilterResult FilterBase::DecodeFilter(const std::string &data)
488 irc::tokenstream tokens(data);
489 tokens.GetToken(res.freeform);
490 tokens.GetToken(res.action);
491 tokens.GetToken(res.flags);
492 if (res.flags == "-")
494 res.FillFlags(res.flags);
495 tokens.GetToken(res.gline_time);
496 tokens.GetToken(res.reason);
498 /* Hax to allow spaces in the freeform without changing the design of the irc protocol */
499 for (std::string::iterator n = res.freeform.begin(); n != res.freeform.end(); n++)
506 void FilterBase::OnSyncOtherMetaData(Module* proto, void* opaque, bool displayable)
508 this->SyncFilters(proto, opaque);
511 void FilterBase::SendFilter(Module* proto, void* opaque, FilterResult* iter)
513 proto->ProtoSendMetaData(opaque, TYPE_OTHER, NULL, "filter", EncodeFilter(iter));
516 void FilterBase::OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
518 if ((target_type == TYPE_OTHER) && (extname == "filter"))
520 FilterResult data = DecodeFilter(extdata);
521 this->AddFilter(data.freeform, data.action, data.reason, data.gline_time, data.flags);
525 class ImplFilter : public FilterResult
530 ImplFilter(Module* mymodule, const std::string &rea, const std::string &act, long glinetime, const std::string &pat, const std::string &flgs)
531 : FilterResult(pat, rea, act, glinetime, flgs)
534 throw ModuleException("Regex module implementing '"+RegexEngine+"' is not loaded!");
536 regex = RegexFactoryRequest(mymodule, rxengine, pat).Create();
544 class ModuleFilter : public FilterBase
546 std::vector<ImplFilter> filters;
552 ModuleFilter(InspIRCd* Me)
553 : FilterBase(Me, "m_filter.so")
558 virtual ~ModuleFilter()
562 virtual FilterResult* FilterMatch(User* user, const std::string &text, int flgs)
564 for (std::vector<ImplFilter>::iterator index = filters.begin(); index != filters.end(); index++)
566 /* Skip ones that dont apply to us */
567 if (!FilterBase::AppliesToMe(user, dynamic_cast<FilterResult*>(&(*index)), flgs))
570 //ServerInstance->Logs->Log("m_filter", DEBUG, "Match '%s' against '%s'", text.c_str(), index->freeform.c_str());
571 if (index->regex->Matches(text))
573 //ServerInstance->Logs->Log("m_filter", DEBUG, "MATCH");
575 if (index != filters.begin())
577 /* Move to head of list for efficiency */
578 filters.erase(index);
579 filters.insert(filters.begin(), fr);
583 //ServerInstance->Logs->Log("m_filter", DEBUG, "NO MATCH");
588 virtual bool DeleteFilter(const std::string &freeform)
590 for (std::vector<ImplFilter>::iterator i = filters.begin(); i != filters.end(); i++)
592 if (i->freeform == freeform)
602 virtual void SyncFilters(Module* proto, void* opaque)
604 for (std::vector<ImplFilter>::iterator i = filters.begin(); i != filters.end(); i++)
606 this->SendFilter(proto, opaque, &(*i));
610 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)
612 for (std::vector<ImplFilter>::iterator i = filters.begin(); i != filters.end(); i++)
614 if (i->freeform == freeform)
616 return std::make_pair(false, "Filter already exists");
622 filters.push_back(ImplFilter(this, reason, type, duration, freeform, flgs));
624 catch (ModuleException &e)
626 ServerInstance->Logs->Log("m_filter", DEFAULT, "Error in regular expression '%s': %s", freeform.c_str(), e.GetReason());
627 return std::make_pair(false, e.GetReason());
629 return std::make_pair(true, "");
632 virtual void OnRehash(User* user, const std::string ¶meter)
634 ConfigReader MyConf(ServerInstance);
635 FilterBase::OnRehash(user, parameter);
639 void ReadFilters(ConfigReader &MyConf)
641 for (int index = 0; index < MyConf.Enumerate("keyword"); index++)
643 this->DeleteFilter(MyConf.ReadValue("keyword", "pattern", index));
645 std::string pattern = MyConf.ReadValue("keyword", "pattern", index);
646 std::string reason = MyConf.ReadValue("keyword", "reason", index);
647 std::string action = MyConf.ReadValue("keyword", "action", index);
648 std::string flgs = MyConf.ReadValue("keyword", "flags", index);
649 long gline_time = ServerInstance->Duration(MyConf.ReadValue("keyword", "duration", index));
657 filters.push_back(ImplFilter(this, reason, action, gline_time, pattern, flgs));
658 ServerInstance->Logs->Log("m_filter", DEFAULT, "Regular expression %s loaded.", pattern.c_str());
660 catch (ModuleException &e)
662 ServerInstance->Logs->Log("m_filter", DEFAULT, "Error in regular expression '%s': %s", pattern.c_str(), e.GetReason());
667 virtual int OnStats(char symbol, User* user, string_list &results)
671 std::string sn = ServerInstance->Config->ServerName;
672 for (std::vector<ImplFilter>::iterator i = filters.begin(); i != filters.end(); i++)
674 results.push_back(sn+" 223 "+user->nick+" :"+RegexEngine+":"+i->freeform+" "+i->flags+" "+i->action+" "+ConvToStr(i->gline_time)+" :"+i->reason);
676 for (std::vector<std::string>::iterator i = exemptfromfilter.begin(); i != exemptfromfilter.end(); ++i)
678 results.push_back(sn+" 223 "+user->nick+" :EXEMPT "+(*i));
685 MODULE_INIT(ModuleFilter)