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"
27 static bool ZlineOnMatch = false;
28 static bool added_zline = false;
30 class RLine : public XLine
35 * @param s_time The set time
36 * @param d The duration of the xline
37 * @param src The sender of the xline
38 * @param re The reason of the xline
39 * @param regex Pattern to match with
42 RLine(time_t s_time, long d, const std::string& src, const std::string& re, const std::string& regexs, dynamic_reference<RegexFactory>& rxfactory)
43 : XLine(s_time, d, src, re, "R")
46 /* This can throw on failure, but if it does we DONT catch it here, we catch it and display it
47 * where the object is created, we might not ALWAYS want it to output stuff to snomask x all the time
49 regex = rxfactory->Create(regexs);
61 LocalUser* lu = IS_LOCAL(u);
65 const std::string host = u->nick + "!" + u->ident + "@" + u->GetRealHost() + " " + u->fullname;
66 const std::string ip = u->nick + "!" + u->ident + "@" + u->GetIPString() + " " + u->fullname;
67 return (regex->Matches(host) || regex->Matches(ip));
70 bool Matches(const std::string &compare)
72 return regex->Matches(compare);
79 ZLine* zl = new ZLine(ServerInstance->Time(), duration ? expiry - ServerInstance->Time() : 0, ServerInstance->Config->ServerName.c_str(), reason.c_str(), u->GetIPString());
80 if (ServerInstance->XLines->AddLine(zl, NULL))
82 std::string timestr = InspIRCd::TimeString(zl->expiry);
83 ServerInstance->SNO->WriteToSnoMask('x', "Z-line added due to R-line match on *@%s%s%s: %s",
84 zl->ipaddr.c_str(), zl->duration ? " to expire on " : "", zl->duration ? timestr.c_str() : "", zl->reason.c_str());
90 DefaultApply(u, "R", false);
93 const std::string& Displayable()
98 std::string matchtext;
104 /** An XLineFactory specialized to generate RLine* pointers
106 class RLineFactory : public XLineFactory
109 dynamic_reference<RegexFactory>& rxfactory;
110 RLineFactory(dynamic_reference<RegexFactory>& rx) : XLineFactory("R"), rxfactory(rx)
116 XLine* Generate(time_t set_time, long duration, std::string source, std::string reason, std::string xline_specific_mask)
120 ServerInstance->SNO->WriteToSnoMask('a', "Cannot create regexes until engine is set to a loaded provider!");
121 throw ModuleException("Regex engine not set or loaded!");
124 return new RLine(set_time, duration, source, reason, xline_specific_mask, rxfactory);
129 * Syntax is same as other lines: RLINE regex_goes_here 1d :reason
131 class CommandRLine : public Command
133 std::string rxengine;
134 RLineFactory& factory;
137 CommandRLine(Module* Creator, RLineFactory& rlf) : Command(Creator,"RLINE", 1, 3), factory(rlf)
139 flags_needed = 'o'; this->syntax = "<regex> [<rline-duration>] :<reason>";
142 CmdResult Handle (const std::vector<std::string>& parameters, User *user)
145 if (parameters.size() >= 3)
147 // Adding - XXX todo make this respect <insane> tag perhaps..
149 unsigned long duration = InspIRCd::Duration(parameters[1]);
154 r = factory.Generate(ServerInstance->Time(), duration, user->nick.c_str(), parameters[2].c_str(), parameters[0].c_str());
156 catch (ModuleException &e)
158 ServerInstance->SNO->WriteToSnoMask('a',"Could not add RLINE: " + e.GetReason());
163 if (ServerInstance->XLines->AddLine(r, user))
167 ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent R-line for %s: %s", user->nick.c_str(), parameters[0].c_str(), parameters[2].c_str());
171 time_t c_requires_crap = duration + ServerInstance->Time();
172 std::string timestr = InspIRCd::TimeString(c_requires_crap);
173 ServerInstance->SNO->WriteToSnoMask('x', "%s added timed R-line for %s to expire on %s: %s", user->nick.c_str(), parameters[0].c_str(), timestr.c_str(), parameters[2].c_str());
176 ServerInstance->XLines->ApplyLines();
181 user->WriteNotice("*** R-Line for " + parameters[0] + " already exists");
187 if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "R", user))
189 ServerInstance->SNO->WriteToSnoMask('x',"%s removed R-line on %s",user->nick.c_str(),parameters[0].c_str());
193 user->WriteNotice("*** R-Line " + parameters[0] + " not found in list, try /stats R.");
200 RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
203 return ROUTE_LOCALONLY; // spanningtree will send ADDLINE
205 return ROUTE_BROADCAST;
209 class ModuleRLine : public Module
211 dynamic_reference<RegexFactory> rxfactory;
214 bool MatchOnNickChange;
216 RegexFactory* factory;
220 : rxfactory(this, "regex"), f(rxfactory), r(this, f)
225 void init() CXX11_OVERRIDE
227 ServerInstance->XLines->RegisterFactory(&f);
232 ServerInstance->XLines->DelAll("R");
233 ServerInstance->XLines->UnregisterFactory(&f);
236 Version GetVersion() CXX11_OVERRIDE
238 return Version("RLINE: Regexp user banning.", VF_COMMON | VF_VENDOR, rxfactory ? rxfactory->name : "");
241 ModResult OnUserRegister(LocalUser* user) CXX11_OVERRIDE
243 // Apply lines on user connect
244 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
252 return MOD_RES_PASSTHRU;
255 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
257 ConfigTag* tag = ServerInstance->Config->ConfValue("rline");
259 MatchOnNickChange = tag->getBool("matchonnickchange");
260 ZlineOnMatch = tag->getBool("zlineonmatch");
261 std::string newrxengine = tag->getString("engine");
263 factory = rxfactory ? (rxfactory.operator->()) : NULL;
265 if (newrxengine.empty())
266 rxfactory.SetProvider("regex");
268 rxfactory.SetProvider("regex/" + newrxengine);
272 if (newrxengine.empty())
273 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: No regex engine loaded - R-Line functionality disabled until this is corrected.");
275 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: Regex engine '%s' is not loaded - R-Line functionality disabled until this is corrected.", newrxengine.c_str());
277 ServerInstance->XLines->DelAll(f.GetType());
279 else if ((!initing) && (rxfactory.operator->() != factory))
281 ServerInstance->SNO->WriteToSnoMask('a', "Regex engine has changed, removing all R-Lines");
282 ServerInstance->XLines->DelAll(f.GetType());
288 ModResult OnStats(Stats::Context& stats) CXX11_OVERRIDE
290 if (stats.GetSymbol() != 'R')
291 return MOD_RES_PASSTHRU;
293 ServerInstance->XLines->InvokeStats("R", 223, stats);
297 void OnUserPostNick(User *user, const std::string &oldnick) CXX11_OVERRIDE
302 if (!MatchOnNickChange)
305 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
314 void OnBackgroundTimer(time_t curtime) CXX11_OVERRIDE
319 ServerInstance->XLines->ApplyLines();
323 void OnUnloadModule(Module* mod) CXX11_OVERRIDE
325 // If the regex engine became unavailable or has changed, remove all rlines
328 ServerInstance->XLines->DelAll(f.GetType());
330 else if (rxfactory.operator->() != factory)
332 factory = rxfactory.operator->();
333 ServerInstance->XLines->DelAll(f.GetType());
337 void Prioritize() CXX11_OVERRIDE
339 Module* mod = ServerInstance->Modules->Find("m_cgiirc.so");
340 ServerInstance->Modules->SetPriority(this, I_OnUserRegister, PRIORITY_AFTER, mod);
344 MODULE_INIT(ModuleRLine)