1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2008 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
18 static Module* rxengine = 0;
19 static Module* mymodule = 0; /* Needed to let RLine send request! */
21 /* $ModDesc: RLINE: Regexp user banning. */
23 class CoreExport RLine : public XLine
28 * @param s_time The set time
29 * @param d The duration of the xline
30 * @param src The sender of the xline
31 * @param re The reason of the xline
32 * @param regex Pattern to match with
35 RLine(InspIRCd* Instance, time_t s_time, long d, const char* src, const char* re, const char* regexs) : XLine(Instance, s_time, d, src, re, "R")
41 ServerInstance->SNO->WriteToSnoMask('x', "Cannot create regexes until engine is set to a loaded provider!");
42 throw ModuleException("Regex engine not set or loaded!");
45 /* This can throw on failure, but if it does we DONT catch it here, we catch it and display it
46 * where the object is created, we might not ALWAYS want it to output stuff to snomask x all the time
48 regex = RegexFactoryRequest(mymodule, rxengine, regexs).Create();
60 std::string compare = u->nick + "!" + u->ident + "@" + u->host + " " + u->fullname;
61 return regex->Matches(compare);
64 bool Matches(const std::string &compare)
66 return regex->Matches(compare);
71 DefaultApply(u, "R", true);
76 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed R-Line %s (set by %s %ld seconds ago)", this->matchtext.c_str(), this->source, this->duration);
79 const char* Displayable()
81 return matchtext.c_str();
84 std::string matchtext;
90 /** An XLineFactory specialized to generate RLine* pointers
92 class CoreExport RLineFactory : public XLineFactory
95 RLineFactory(InspIRCd* Instance) : XLineFactory(Instance, "R") { }
99 XLine* Generate(time_t set_time, long duration, const char* source, const char* reason, const char* xline_specific_mask)
101 return new RLine(ServerInstance, set_time, duration, source, reason, xline_specific_mask);
106 * Syntax is same as other lines: RLINE regex_goes_here 1d :reason
108 class CommandRLine : public Command
110 std::string rxengine;
113 CommandRLine (InspIRCd* Instance) : Command(Instance,"RLINE", "o", 1)
115 this->source = "m_rline.so";
118 CmdResult Handle (const std::vector<std::string>& parameters, User *user)
121 if (parameters.size() >= 3)
123 // Adding - XXX todo make this respect <insane> tag perhaps..
125 long duration = ServerInstance->Duration(parameters[1]);
130 r = new RLine(ServerInstance, ServerInstance->Time(), duration, user->nick.c_str(), parameters[2].c_str(), parameters[0].c_str());
132 catch (ModuleException &e)
134 ServerInstance->SNO->WriteToSnoMask('x',"Could not add RLINE: %s", e.GetReason());
139 if (ServerInstance->XLines->AddLine(r, user))
143 ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent R-Line for %s.", user->nick.c_str(), parameters[0].c_str());
147 time_t c_requires_crap = duration + ServerInstance->Time();
148 ServerInstance->SNO->WriteToSnoMask('x', "%s added timed R-Line for %s, expires on %s", user->nick.c_str(), parameters[0].c_str(),
149 ServerInstance->TimeString(c_requires_crap).c_str());
152 ServerInstance->XLines->ApplyLines();
157 user->WriteServ("NOTICE %s :*** R-Line for %s already exists", user->nick.c_str(), parameters[0].c_str());
163 if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "R", user))
165 ServerInstance->SNO->WriteToSnoMask('x',"%s Removed R-Line on %s.",user->nick.c_str(),parameters[0].c_str());
169 user->WriteServ("NOTICE %s :*** R-Line %s not found in list, try /stats R.",user->nick.c_str(),parameters[0].c_str());
177 class ModuleRLine : public Module
182 bool MatchOnNickChange;
183 std::string RegexEngine;
186 ModuleRLine(InspIRCd* Me) : Module(Me)
191 Me->Modules->UseInterface("RegularExpression");
193 // Create a new command
194 r = new CommandRLine(ServerInstance);
195 ServerInstance->AddCommand(r);
197 f = new RLineFactory(ServerInstance);
198 ServerInstance->XLines->RegisterFactory(f);
200 Implementation eventlist[] = { I_OnUserConnect, I_OnRehash, I_OnUserPostNick, I_OnLoadModule, I_OnStats };
201 ServerInstance->Modules->Attach(eventlist, this, 5);
205 virtual ~ModuleRLine()
207 ServerInstance->Modules->DoneWithInterface("RegularExpression");
208 ServerInstance->XLines->DelAll("R");
209 ServerInstance->XLines->UnregisterFactory(f);
212 virtual Version GetVersion()
214 return Version("$Id$", VF_COMMON | VF_VENDOR, API_VERSION);
217 virtual void OnUserConnect(User* user)
219 // Apply lines on user connect
220 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
229 virtual void OnRehash(User *user, const std::string ¶meter)
231 ConfigReader Conf(ServerInstance);
233 MatchOnNickChange = Conf.ReadFlag("rline", "matchonnickchange", 0);
234 std::string newrxengine = Conf.ReadValue("rline", "engine", 0);
236 if (!RegexEngine.empty())
238 if (RegexEngine == newrxengine)
241 ServerInstance->SNO->WriteToSnoMask('x', "Dumping all R-Lines due to regex engine change (was '%s', now '%s')", RegexEngine.c_str(), newrxengine.c_str());
242 ServerInstance->XLines->DelAll("R");
245 RegexEngine = newrxengine;
246 modulelist* ml = ServerInstance->Modules->FindInterface("RegularExpression");
249 for (modulelist::iterator i = ml->begin(); i != ml->end(); ++i)
251 if (RegexNameRequest(this, *i).Send() == newrxengine)
253 ServerInstance->SNO->WriteToSnoMask('x', "R-Line now using engine '%s'", RegexEngine.c_str());
260 ServerInstance->SNO->WriteToSnoMask('x', "WARNING: Regex engine '%s' is not loaded - R-Line functionality disabled until this is corrected.", RegexEngine.c_str());
264 virtual int OnStats(char symbol, User* user, string_list &results)
269 ServerInstance->XLines->InvokeStats("R", 223, user, results);
273 virtual void OnLoadModule(Module* mod, const std::string& name)
275 if (ServerInstance->Modules->ModuleHasInterface(mod, "RegularExpression"))
277 std::string rxname = RegexNameRequest(this, mod).Send();
278 if (rxname == RegexEngine)
280 ServerInstance->SNO->WriteToSnoMask('x', "R-Line now using engine '%s'", RegexEngine.c_str());
286 virtual void OnUserPostNick(User *user, const std::string &oldnick)
291 if (!MatchOnNickChange)
294 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
305 MODULE_INIT(ModuleRLine)