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. */
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, std::string src, std::string re, std::string regexs, dynamic_reference<RegexFactory>& rxfactory)
45 : XLine(s_time, d, src, re, "R")
49 /* This can throw on failure, but if it does we DONT catch it here, we catch it and display it
50 * where the object is created, we might not ALWAYS want it to output stuff to snomask x all the time
52 regex = rxfactory->Create(regexs);
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);
96 ServerInstance->SNO->WriteToSnoMask('x',"Removing expired R-line %s (set by %s %ld seconds ago)",
97 this->matchtext.c_str(), this->source.c_str(), (long int)(ServerInstance->Time() - this->set_time));
100 const char* Displayable()
102 return matchtext.c_str();
105 std::string matchtext;
111 /** An XLineFactory specialized to generate RLine* pointers
113 class RLineFactory : public XLineFactory
116 dynamic_reference<RegexFactory>& rxfactory;
117 RLineFactory(dynamic_reference<RegexFactory>& rx) : XLineFactory("R"), rxfactory(rx)
123 XLine* Generate(time_t set_time, long duration, std::string source, std::string reason, std::string xline_specific_mask)
127 ServerInstance->SNO->WriteToSnoMask('a', "Cannot create regexes until engine is set to a loaded provider!");
128 throw ModuleException("Regex engine not set or loaded!");
131 return new RLine(set_time, duration, source, reason, xline_specific_mask, rxfactory);
140 * Syntax is same as other lines: RLINE regex_goes_here 1d :reason
142 class CommandRLine : public Command
144 std::string rxengine;
145 RLineFactory& factory;
148 CommandRLine(Module* Creator, RLineFactory& rlf) : Command(Creator,"RLINE", 1, 3), factory(rlf)
150 flags_needed = 'o'; this->syntax = "<regex> [<rline-duration>] :<reason>";
153 CmdResult Handle (const std::vector<std::string>& parameters, User *user)
156 if (parameters.size() >= 3)
158 // Adding - XXX todo make this respect <insane> tag perhaps..
160 long duration = ServerInstance->Duration(parameters[1]);
165 r = factory.Generate(ServerInstance->Time(), duration, user->nick.c_str(), parameters[2].c_str(), parameters[0].c_str());
167 catch (ModuleException &e)
169 ServerInstance->SNO->WriteToSnoMask('a',"Could not add RLINE: %s", e.GetReason());
174 if (ServerInstance->XLines->AddLine(r, user))
178 ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent R-line for %s: %s", user->nick.c_str(), parameters[0].c_str(), parameters[2].c_str());
182 time_t c_requires_crap = duration + ServerInstance->Time();
183 std::string timestr = ServerInstance->TimeString(c_requires_crap);
184 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());
187 ServerInstance->XLines->ApplyLines();
192 user->WriteServ("NOTICE %s :*** R-Line for %s already exists", user->nick.c_str(), parameters[0].c_str());
198 if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "R", user))
200 ServerInstance->SNO->WriteToSnoMask('x',"%s removed R-line on %s",user->nick.c_str(),parameters[0].c_str());
204 user->WriteServ("NOTICE %s :*** R-Line %s not found in list, try /stats R.",user->nick.c_str(),parameters[0].c_str());
211 RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
214 return ROUTE_LOCALONLY; // spanningtree will send ADDLINE
216 return ROUTE_BROADCAST;
220 class ModuleRLine : public Module
223 dynamic_reference<RegexFactory> rxfactory;
226 bool MatchOnNickChange;
228 RegexFactory* factory;
232 : rxfactory(this, "regex"), f(rxfactory), r(this, f)
241 ServerInstance->Modules->AddService(r);
242 ServerInstance->XLines->RegisterFactory(&f);
244 Implementation eventlist[] = { I_OnUserRegister, I_OnRehash, I_OnUserPostNick, I_OnStats, I_OnBackgroundTimer, I_OnUnloadModule };
245 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
248 virtual ~ModuleRLine()
250 ServerInstance->XLines->DelAll("R");
251 ServerInstance->XLines->UnregisterFactory(&f);
254 virtual Version GetVersion()
256 return Version("RLINE: Regexp user banning.", VF_COMMON | VF_VENDOR, rxfactory ? rxfactory->name : "");
259 ModResult OnUserRegister(LocalUser* user)
261 // Apply lines on user connect
262 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
270 return MOD_RES_PASSTHRU;
273 virtual void OnRehash(User *user)
275 ConfigTag* tag = ServerInstance->Config->ConfValue("rline");
277 MatchOnNickChange = tag->getBool("matchonnickchange");
278 ZlineOnMatch = tag->getBool("zlineonmatch");
279 std::string newrxengine = tag->getString("engine");
281 factory = rxfactory ? (rxfactory.operator->()) : NULL;
283 if (newrxengine.empty())
284 rxfactory.SetProvider("regex");
286 rxfactory.SetProvider("regex/" + newrxengine);
290 if (newrxengine.empty())
291 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: No regex engine loaded - R-Line functionality disabled until this is corrected.");
293 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: Regex engine '%s' is not loaded - R-Line functionality disabled until this is corrected.", newrxengine.c_str());
295 ServerInstance->XLines->DelAll(f.GetType());
297 else if ((!initing) && (rxfactory.operator->() != factory))
299 ServerInstance->SNO->WriteToSnoMask('a', "Regex engine has changed, removing all R-Lines");
300 ServerInstance->XLines->DelAll(f.GetType());
306 virtual ModResult OnStats(char symbol, User* user, string_list &results)
309 return MOD_RES_PASSTHRU;
311 ServerInstance->XLines->InvokeStats("R", 223, user, results);
315 virtual void OnUserPostNick(User *user, const std::string &oldnick)
320 if (!MatchOnNickChange)
323 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
332 virtual void OnBackgroundTimer(time_t curtime)
337 ServerInstance->XLines->ApplyLines();
341 void OnUnloadModule(Module* mod)
343 // If the regex engine became unavailable or has changed, remove all rlines
346 ServerInstance->XLines->DelAll(f.GetType());
348 else if (rxfactory.operator->() != factory)
350 factory = rxfactory.operator->();
351 ServerInstance->XLines->DelAll(f.GetType());
357 Module* mod = ServerInstance->Modules->Find("m_cgiirc.so");
358 ServerInstance->Modules->SetPriority(this, I_OnUserRegister, PRIORITY_AFTER, mod);
362 MODULE_INIT(ModuleRLine)