2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
6 * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
7 * Copyright (C) 2008 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/>.
24 #include "modules/regex.h"
25 #include "modules/stats.h"
28 static bool ZlineOnMatch = false;
29 static bool added_zline = false;
31 class RLine : public XLine
36 * @param s_time The set time
37 * @param d The duration of the xline
38 * @param src The sender of the xline
39 * @param re The reason of the xline
40 * @param regex Pattern to match with
43 RLine(time_t s_time, unsigned long d, const std::string& src, const std::string& re, const std::string& regexs, dynamic_reference<RegexFactory>& rxfactory)
44 : XLine(s_time, d, src, re, "R")
47 /* This can throw on failure, but if it does we DONT catch it here, we catch it and display it
48 * where the object is created, we might not ALWAYS want it to output stuff to snomask x all the time
50 regex = rxfactory->Create(regexs);
60 bool Matches(User* u) CXX11_OVERRIDE
62 LocalUser* lu = IS_LOCAL(u);
66 const std::string host = u->nick + "!" + u->ident + "@" + u->GetRealHost() + " " + u->GetRealName();
67 const std::string ip = u->nick + "!" + u->ident + "@" + u->GetIPString() + " " + u->GetRealName();
68 return (regex->Matches(host) || regex->Matches(ip));
71 bool Matches(const std::string& compare) CXX11_OVERRIDE
73 return regex->Matches(compare);
76 void Apply(User* u) CXX11_OVERRIDE
80 ZLine* zl = new ZLine(ServerInstance->Time(), duration ? expiry - ServerInstance->Time() : 0, ServerInstance->Config->ServerName.c_str(), reason.c_str(), u->GetIPString());
81 if (ServerInstance->XLines->AddLine(zl, NULL))
83 std::string expirystr = zl->duration ? InspIRCd::Format(" to expire in %s (on %s)", InspIRCd::DurationString(zl->duration).c_str(), InspIRCd::TimeString(zl->expiry).c_str()) : "";
84 ServerInstance->SNO->WriteToSnoMask('x', "Z-line added due to R-line match on %s%s: %s",
85 zl->ipaddr.c_str(), expirystr.c_str(), zl->reason.c_str());
91 DefaultApply(u, "R", false);
94 const std::string& Displayable() CXX11_OVERRIDE
99 std::string matchtext;
105 /** An XLineFactory specialized to generate RLine* pointers
107 class RLineFactory : public XLineFactory
110 dynamic_reference<RegexFactory>& rxfactory;
111 RLineFactory(dynamic_reference<RegexFactory>& rx) : XLineFactory("R"), rxfactory(rx)
117 XLine* Generate(time_t set_time, unsigned long duration, const std::string& source, const std::string& reason, const std::string& xline_specific_mask) CXX11_OVERRIDE
121 ServerInstance->SNO->WriteToSnoMask('a', "Cannot create regexes until engine is set to a loaded provider!");
122 throw ModuleException("Regex engine not set or loaded!");
125 return new RLine(set_time, duration, source, reason, xline_specific_mask, rxfactory);
130 * Syntax is same as other lines: RLINE regex_goes_here 1d :reason
132 class CommandRLine : public Command
134 std::string rxengine;
135 RLineFactory& factory;
138 CommandRLine(Module* Creator, RLineFactory& rlf) : Command(Creator,"RLINE", 1, 3), factory(rlf)
140 flags_needed = 'o'; this->syntax = "<regex> [<duration> :<reason>]";
143 CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
146 if (parameters.size() >= 3)
148 // Adding - XXX todo make this respect <insane> tag perhaps..
150 unsigned long duration;
151 if (!InspIRCd::Duration(parameters[1], duration))
153 user->WriteNotice("*** Invalid duration for R-line.");
160 r = factory.Generate(ServerInstance->Time(), duration, user->nick.c_str(), parameters[2].c_str(), parameters[0].c_str());
162 catch (ModuleException &e)
164 ServerInstance->SNO->WriteToSnoMask('a',"Could not add RLINE: " + e.GetReason());
169 if (ServerInstance->XLines->AddLine(r, user))
173 ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent R-line for %s: %s", user->nick.c_str(), parameters[0].c_str(), parameters[2].c_str());
177 ServerInstance->SNO->WriteToSnoMask('x', "%s added timed R-line for %s to expire in %s (on %s): %s",
178 user->nick.c_str(), parameters[0].c_str(), InspIRCd::DurationString(duration).c_str(),
179 InspIRCd::TimeString(ServerInstance->Time() + duration).c_str(), parameters[2].c_str());
182 ServerInstance->XLines->ApplyLines();
187 user->WriteNotice("*** R-line for " + parameters[0] + " already exists.");
195 if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "R", reason, user))
197 ServerInstance->SNO->WriteToSnoMask('x', "%s removed R-line on %s: %s", user->nick.c_str(), parameters[0].c_str(), reason.c_str());
201 user->WriteNotice("*** R-line " + parameters[0] + " not found in list, try /stats R.");
208 RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
211 return ROUTE_LOCALONLY; // spanningtree will send ADDLINE
213 return ROUTE_BROADCAST;
217 class ModuleRLine : public Module, public Stats::EventListener
219 dynamic_reference<RegexFactory> rxfactory;
222 bool MatchOnNickChange;
224 RegexFactory* factory;
228 : Stats::EventListener(this)
229 , rxfactory(this, "regex")
236 void init() CXX11_OVERRIDE
238 ServerInstance->XLines->RegisterFactory(&f);
243 ServerInstance->XLines->DelAll("R");
244 ServerInstance->XLines->UnregisterFactory(&f);
247 Version GetVersion() CXX11_OVERRIDE
249 return Version("RLINE: Regexp user banning.", VF_COMMON | VF_VENDOR, rxfactory ? rxfactory->name : "");
252 ModResult OnUserRegister(LocalUser* user) CXX11_OVERRIDE
254 // Apply lines on user connect
255 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
263 return MOD_RES_PASSTHRU;
266 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
268 ConfigTag* tag = ServerInstance->Config->ConfValue("rline");
270 MatchOnNickChange = tag->getBool("matchonnickchange");
271 ZlineOnMatch = tag->getBool("zlineonmatch");
272 std::string newrxengine = tag->getString("engine");
274 factory = rxfactory ? (rxfactory.operator->()) : NULL;
276 if (newrxengine.empty())
277 rxfactory.SetProvider("regex");
279 rxfactory.SetProvider("regex/" + newrxengine);
283 if (newrxengine.empty())
284 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: No regex engine loaded - R-line functionality disabled until this is corrected.");
286 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: Regex engine '%s' is not loaded - R-line functionality disabled until this is corrected.", newrxengine.c_str());
288 ServerInstance->XLines->DelAll(f.GetType());
290 else if ((!initing) && (rxfactory.operator->() != factory))
292 ServerInstance->SNO->WriteToSnoMask('a', "Regex engine has changed, removing all R-lines.");
293 ServerInstance->XLines->DelAll(f.GetType());
299 ModResult OnStats(Stats::Context& stats) CXX11_OVERRIDE
301 if (stats.GetSymbol() != 'R')
302 return MOD_RES_PASSTHRU;
304 ServerInstance->XLines->InvokeStats("R", 223, stats);
308 void OnUserPostNick(User *user, const std::string &oldnick) CXX11_OVERRIDE
313 if (!MatchOnNickChange)
316 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
325 void OnBackgroundTimer(time_t curtime) CXX11_OVERRIDE
330 ServerInstance->XLines->ApplyLines();
334 void OnUnloadModule(Module* mod) CXX11_OVERRIDE
336 // If the regex engine became unavailable or has changed, remove all R-lines.
339 ServerInstance->XLines->DelAll(f.GetType());
341 else if (rxfactory.operator->() != factory)
343 factory = rxfactory.operator->();
344 ServerInstance->XLines->DelAll(f.GetType());
348 void Prioritize() CXX11_OVERRIDE
350 Module* mod = ServerInstance->Modules->Find("m_cgiirc.so");
351 ServerInstance->Modules->SetPriority(this, I_OnUserRegister, PRIORITY_AFTER, mod);
355 MODULE_INIT(ModuleRLine)