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/>.
23 /* $ModDesc: RLINE: Regexp user banning. */
26 #include "modules/regex.h"
29 static bool ZlineOnMatch = false;
30 static bool added_zline = false;
32 class RLine : public XLine
37 * @param s_time The set time
38 * @param d The duration of the xline
39 * @param src The sender of the xline
40 * @param re The reason of the xline
41 * @param regex Pattern to match with
44 RLine(time_t s_time, long d, const std::string& src, const std::string& re, const std::string& regexs, dynamic_reference<RegexFactory>& rxfactory)
45 : XLine(s_time, d, src, re, "R")
48 /* This can throw on failure, but if it does we DONT catch it here, we catch it and display it
49 * where the object is created, we might not ALWAYS want it to output stuff to snomask x all the time
51 regex = rxfactory->Create(regexs);
63 LocalUser* lu = IS_LOCAL(u);
67 std::string compare = u->nick + "!" + u->ident + "@" + u->host + " " + u->fullname;
68 return regex->Matches(compare);
71 bool Matches(const std::string &compare)
73 return regex->Matches(compare);
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 timestr = ServerInstance->TimeString(zl->expiry);
84 ServerInstance->SNO->WriteToSnoMask('x', "Z-line added due to R-line match on *@%s%s%s: %s",
85 zl->ipaddr.c_str(), zl->duration ? " to expire on " : "", zl->duration ? timestr.c_str() : "", zl->reason.c_str());
91 DefaultApply(u, "R", false);
94 const std::string& Displayable()
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, long duration, std::string source, std::string reason, std::string xline_specific_mask)
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> [<rline-duration>] :<reason>";
143 CmdResult Handle (const std::vector<std::string>& parameters, User *user)
146 if (parameters.size() >= 3)
148 // Adding - XXX todo make this respect <insane> tag perhaps..
150 unsigned long duration = InspIRCd::Duration(parameters[1]);
155 r = factory.Generate(ServerInstance->Time(), duration, user->nick.c_str(), parameters[2].c_str(), parameters[0].c_str());
157 catch (ModuleException &e)
159 ServerInstance->SNO->WriteToSnoMask('a',"Could not add RLINE: %s", e.GetReason());
164 if (ServerInstance->XLines->AddLine(r, user))
168 ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent R-line for %s: %s", user->nick.c_str(), parameters[0].c_str(), parameters[2].c_str());
172 time_t c_requires_crap = duration + ServerInstance->Time();
173 std::string timestr = ServerInstance->TimeString(c_requires_crap);
174 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());
177 ServerInstance->XLines->ApplyLines();
182 user->WriteNotice("*** R-Line for " + parameters[0] + " already exists");
188 if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "R", user))
190 ServerInstance->SNO->WriteToSnoMask('x',"%s removed R-line on %s",user->nick.c_str(),parameters[0].c_str());
194 user->WriteNotice("*** R-Line " + parameters[0] + " not found in list, try /stats R.");
201 RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
204 return ROUTE_LOCALONLY; // spanningtree will send ADDLINE
206 return ROUTE_BROADCAST;
210 class ModuleRLine : public Module
212 dynamic_reference<RegexFactory> rxfactory;
215 bool MatchOnNickChange;
217 RegexFactory* factory;
221 : rxfactory(this, "regex"), f(rxfactory), r(this, f)
226 void init() CXX11_OVERRIDE
230 ServerInstance->Modules->AddService(r);
231 ServerInstance->XLines->RegisterFactory(&f);
233 Implementation eventlist[] = { I_OnUserRegister, I_OnRehash, I_OnUserPostNick, I_OnStats, I_OnBackgroundTimer, I_OnUnloadModule };
234 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
239 ServerInstance->XLines->DelAll("R");
240 ServerInstance->XLines->UnregisterFactory(&f);
243 Version GetVersion() CXX11_OVERRIDE
245 return Version("RLINE: Regexp user banning.", VF_COMMON | VF_VENDOR, rxfactory ? rxfactory->name : "");
248 ModResult OnUserRegister(LocalUser* user) CXX11_OVERRIDE
250 // Apply lines on user connect
251 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
259 return MOD_RES_PASSTHRU;
262 void OnRehash(User *user) CXX11_OVERRIDE
264 ConfigTag* tag = ServerInstance->Config->ConfValue("rline");
266 MatchOnNickChange = tag->getBool("matchonnickchange");
267 ZlineOnMatch = tag->getBool("zlineonmatch");
268 std::string newrxengine = tag->getString("engine");
270 factory = rxfactory ? (rxfactory.operator->()) : NULL;
272 if (newrxengine.empty())
273 rxfactory.SetProvider("regex");
275 rxfactory.SetProvider("regex/" + newrxengine);
279 if (newrxengine.empty())
280 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: No regex engine loaded - R-Line functionality disabled until this is corrected.");
282 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: Regex engine '%s' is not loaded - R-Line functionality disabled until this is corrected.", newrxengine.c_str());
284 ServerInstance->XLines->DelAll(f.GetType());
286 else if ((!initing) && (rxfactory.operator->() != factory))
288 ServerInstance->SNO->WriteToSnoMask('a', "Regex engine has changed, removing all R-Lines");
289 ServerInstance->XLines->DelAll(f.GetType());
295 ModResult OnStats(char symbol, User* user, string_list &results) CXX11_OVERRIDE
298 return MOD_RES_PASSTHRU;
300 ServerInstance->XLines->InvokeStats("R", 223, user, results);
304 void OnUserPostNick(User *user, const std::string &oldnick) CXX11_OVERRIDE
309 if (!MatchOnNickChange)
312 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
321 void OnBackgroundTimer(time_t curtime) CXX11_OVERRIDE
326 ServerInstance->XLines->ApplyLines();
330 void OnUnloadModule(Module* mod) CXX11_OVERRIDE
332 // If the regex engine became unavailable or has changed, remove all rlines
335 ServerInstance->XLines->DelAll(f.GetType());
337 else if (rxfactory.operator->() != factory)
339 factory = rxfactory.operator->();
340 ServerInstance->XLines->DelAll(f.GetType());
346 Module* mod = ServerInstance->Modules->Find("m_cgiirc.so");
347 ServerInstance->Modules->SetPriority(this, I_OnUserRegister, PRIORITY_AFTER, mod);
351 MODULE_INIT(ModuleRLine)