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, 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);
66 std::string compare = u->nick + "!" + u->ident + "@" + u->host + " " + u->fullname;
67 return regex->Matches(compare);
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 = ServerInstance->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);
95 ServerInstance->SNO->WriteToSnoMask('x',"Removing expired R-line %s (set by %s %ld seconds ago)",
96 this->matchtext.c_str(), this->source.c_str(), (long int)(ServerInstance->Time() - this->set_time));
99 const char* Displayable()
101 return matchtext.c_str();
104 std::string matchtext;
110 /** An XLineFactory specialized to generate RLine* pointers
112 class RLineFactory : public XLineFactory
115 dynamic_reference<RegexFactory>& rxfactory;
116 RLineFactory(dynamic_reference<RegexFactory>& rx) : XLineFactory("R"), rxfactory(rx)
122 XLine* Generate(time_t set_time, long duration, std::string source, std::string reason, std::string xline_specific_mask)
126 ServerInstance->SNO->WriteToSnoMask('a', "Cannot create regexes until engine is set to a loaded provider!");
127 throw ModuleException("Regex engine not set or loaded!");
130 return new RLine(set_time, duration, source, reason, xline_specific_mask, rxfactory);
139 * Syntax is same as other lines: RLINE regex_goes_here 1d :reason
141 class CommandRLine : public Command
143 std::string rxengine;
144 RLineFactory& factory;
147 CommandRLine(Module* Creator, RLineFactory& rlf) : Command(Creator,"RLINE", 1, 3), factory(rlf)
149 flags_needed = 'o'; this->syntax = "<regex> [<rline-duration>] :<reason>";
152 CmdResult Handle (const std::vector<std::string>& parameters, User *user)
155 if (parameters.size() >= 3)
157 // Adding - XXX todo make this respect <insane> tag perhaps..
159 long duration = ServerInstance->Duration(parameters[1]);
164 r = factory.Generate(ServerInstance->Time(), duration, user->nick.c_str(), parameters[2].c_str(), parameters[0].c_str());
166 catch (ModuleException &e)
168 ServerInstance->SNO->WriteToSnoMask('a',"Could not add RLINE: %s", e.GetReason());
173 if (ServerInstance->XLines->AddLine(r, user))
177 ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent R-line for %s: %s", user->nick.c_str(), parameters[0].c_str(), parameters[2].c_str());
181 time_t c_requires_crap = duration + ServerInstance->Time();
182 std::string timestr = ServerInstance->TimeString(c_requires_crap);
183 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());
186 ServerInstance->XLines->ApplyLines();
191 user->WriteServ("NOTICE %s :*** R-Line for %s already exists", user->nick.c_str(), parameters[0].c_str());
197 if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "R", user))
199 ServerInstance->SNO->WriteToSnoMask('x',"%s removed R-line on %s",user->nick.c_str(),parameters[0].c_str());
203 user->WriteServ("NOTICE %s :*** R-Line %s not found in list, try /stats R.",user->nick.c_str(),parameters[0].c_str());
210 RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
213 return ROUTE_LOCALONLY; // spanningtree will send ADDLINE
215 return ROUTE_BROADCAST;
219 class ModuleRLine : public Module
222 dynamic_reference<RegexFactory> rxfactory;
225 bool MatchOnNickChange;
227 RegexFactory* factory;
231 : rxfactory(this, "regex"), f(rxfactory), r(this, f)
240 ServerInstance->Modules->AddService(r);
241 ServerInstance->XLines->RegisterFactory(&f);
243 Implementation eventlist[] = { I_OnUserRegister, I_OnRehash, I_OnUserPostNick, I_OnStats, I_OnBackgroundTimer, I_OnUnloadModule };
244 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
247 virtual ~ModuleRLine()
249 ServerInstance->XLines->DelAll("R");
250 ServerInstance->XLines->UnregisterFactory(&f);
253 virtual Version GetVersion()
255 return Version("RLINE: Regexp user banning.", VF_COMMON | VF_VENDOR, rxfactory ? rxfactory->name : "");
258 ModResult OnUserRegister(LocalUser* user)
260 // Apply lines on user connect
261 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
269 return MOD_RES_PASSTHRU;
272 virtual void OnRehash(User *user)
274 ConfigTag* tag = ServerInstance->Config->ConfValue("rline");
276 MatchOnNickChange = tag->getBool("matchonnickchange");
277 ZlineOnMatch = tag->getBool("zlineonmatch");
278 std::string newrxengine = tag->getString("engine");
280 factory = rxfactory ? (rxfactory.operator->()) : NULL;
282 if (newrxengine.empty())
283 rxfactory.SetProvider("regex");
285 rxfactory.SetProvider("regex/" + newrxengine);
289 if (newrxengine.empty())
290 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: No regex engine loaded - R-Line functionality disabled until this is corrected.");
292 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: Regex engine '%s' is not loaded - R-Line functionality disabled until this is corrected.", newrxengine.c_str());
294 ServerInstance->XLines->DelAll(f.GetType());
296 else if ((!initing) && (rxfactory.operator->() != factory))
298 ServerInstance->SNO->WriteToSnoMask('a', "Regex engine has changed, removing all R-Lines");
299 ServerInstance->XLines->DelAll(f.GetType());
305 virtual ModResult OnStats(char symbol, User* user, string_list &results)
308 return MOD_RES_PASSTHRU;
310 ServerInstance->XLines->InvokeStats("R", 223, user, results);
314 virtual void OnUserPostNick(User *user, const std::string &oldnick)
319 if (!MatchOnNickChange)
322 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
331 virtual void OnBackgroundTimer(time_t curtime)
336 ServerInstance->XLines->ApplyLines();
340 void OnUnloadModule(Module* mod)
342 // If the regex engine became unavailable or has changed, remove all rlines
345 ServerInstance->XLines->DelAll(f.GetType());
347 else if (rxfactory.operator->() != factory)
349 factory = rxfactory.operator->();
350 ServerInstance->XLines->DelAll(f.GetType());
356 Module* mod = ServerInstance->Modules->Find("m_cgiirc.so");
357 ServerInstance->Modules->SetPriority(this, I_OnUserRegister, PRIORITY_AFTER, mod);
361 MODULE_INIT(ModuleRLine)