1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
18 static Module* rxengine = NULL;
19 static Module* mymodule = NULL; /* Needed to let RLine send request! */
21 /* $ModDesc: RLINE: Regexp user banning. */
23 class 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();
63 std::string compare = u->nick + "!" + u->ident + "@" + u->host + " " + u->fullname;
64 return regex->Matches(compare);
67 bool Matches(const std::string &compare)
69 return regex->Matches(compare);
74 DefaultApply(u, "R", true);
79 ServerInstance->SNO->WriteToSnoMask('x',"Removing expired R-Line %s (set by %s %ld seconds ago)", this->matchtext.c_str(), this->source, (long int)(ServerInstance->Time() - this->set_time));
82 const char* Displayable()
84 return matchtext.c_str();
87 std::string matchtext;
93 /** An XLineFactory specialized to generate RLine* pointers
95 class RLineFactory : public XLineFactory
98 RLineFactory(InspIRCd* Instance) : XLineFactory(Instance, "R")
104 XLine* Generate(time_t set_time, long duration, const char* source, const char* reason, const char* xline_specific_mask)
106 return new RLine(ServerInstance, set_time, duration, source, reason, xline_specific_mask);
115 * Syntax is same as other lines: RLINE regex_goes_here 1d :reason
117 class CommandRLine : public Command
119 std::string rxengine;
122 CommandRLine (InspIRCd* Instance) : Command(Instance,"RLINE", "o", 1, 3)
124 this->source = "m_rline.so";
125 this->syntax = "<regex> [<rline-duration>] :<reason>";
128 CmdResult Handle (const std::vector<std::string>& parameters, User *user)
131 if (parameters.size() >= 3)
133 // Adding - XXX todo make this respect <insane> tag perhaps..
135 long duration = ServerInstance->Duration(parameters[1]);
140 r = new RLine(ServerInstance, ServerInstance->Time(), duration, user->nick.c_str(), parameters[2].c_str(), parameters[0].c_str());
142 catch (ModuleException &e)
144 ServerInstance->SNO->WriteToSnoMask('x',"Could not add RLINE: %s", e.GetReason());
149 if (ServerInstance->XLines->AddLine(r, user))
153 ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent R-Line for %s: %s", user->nick.c_str(), parameters[0].c_str(), parameters[2].c_str());
157 time_t c_requires_crap = duration + ServerInstance->Time();
158 ServerInstance->SNO->WriteToSnoMask('x', "%s added timed R-Line for %s, expires on %s: %s", user->nick.c_str(), parameters[0].c_str(), ServerInstance->TimeString(c_requires_crap).c_str(), parameters[2].c_str());
161 ServerInstance->XLines->ApplyLines();
166 user->WriteServ("NOTICE %s :*** R-Line for %s already exists", user->nick.c_str(), parameters[0].c_str());
172 if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "R", user))
174 ServerInstance->SNO->WriteToSnoMask('x',"%s Removed R-Line on %s.",user->nick.c_str(),parameters[0].c_str());
178 user->WriteServ("NOTICE %s :*** R-Line %s not found in list, try /stats R.",user->nick.c_str(),parameters[0].c_str());
186 class ModuleRLine : public Module
191 bool MatchOnNickChange;
192 std::string RegexEngine;
195 ModuleRLine(InspIRCd* Me) : Module(Me)
200 Me->Modules->UseInterface("RegularExpression");
202 // Create a new command
203 r = new CommandRLine(ServerInstance);
204 ServerInstance->AddCommand(r);
206 f = new RLineFactory(ServerInstance);
207 ServerInstance->XLines->RegisterFactory(f);
209 Implementation eventlist[] = { I_OnUserConnect, I_OnRehash, I_OnUserPostNick, I_OnLoadModule, I_OnStats };
210 ServerInstance->Modules->Attach(eventlist, this, 5);
214 virtual ~ModuleRLine()
216 ServerInstance->Modules->DoneWithInterface("RegularExpression");
217 ServerInstance->XLines->DelAll("R");
218 ServerInstance->XLines->UnregisterFactory(f);
221 virtual Version GetVersion()
223 return Version("$Id$", VF_COMMON | VF_VENDOR, API_VERSION);
226 virtual void OnUserConnect(User* user)
228 // Apply lines on user connect
229 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
238 virtual void OnRehash(User *user)
240 ConfigReader Conf(ServerInstance);
242 MatchOnNickChange = Conf.ReadFlag("rline", "matchonnickchange", 0);
243 std::string newrxengine = Conf.ReadValue("rline", "engine", 0);
245 if (!RegexEngine.empty())
247 if (RegexEngine == newrxengine)
250 ServerInstance->SNO->WriteToSnoMask('x', "Dumping all R-Lines due to regex engine change (was '%s', now '%s')", RegexEngine.c_str(), newrxengine.c_str());
251 ServerInstance->XLines->DelAll("R");
254 RegexEngine = newrxengine;
255 modulelist* ml = ServerInstance->Modules->FindInterface("RegularExpression");
258 for (modulelist::iterator i = ml->begin(); i != ml->end(); ++i)
260 if (RegexNameRequest(this, *i).Send() == newrxengine)
262 ServerInstance->SNO->WriteToSnoMask('x', "R-Line now using engine '%s'", RegexEngine.c_str());
269 ServerInstance->SNO->WriteToSnoMask('x', "WARNING: Regex engine '%s' is not loaded - R-Line functionality disabled until this is corrected.", RegexEngine.c_str());
273 virtual int OnStats(char symbol, User* user, string_list &results)
278 ServerInstance->XLines->InvokeStats("R", 223, user, results);
282 virtual void OnLoadModule(Module* mod, const std::string& name)
284 if (ServerInstance->Modules->ModuleHasInterface(mod, "RegularExpression"))
286 std::string rxname = RegexNameRequest(this, mod).Send();
287 if (rxname == RegexEngine)
289 ServerInstance->SNO->WriteToSnoMask('x', "R-Line now using engine '%s'", RegexEngine.c_str());
295 virtual void OnUserPostNick(User *user, const std::string &oldnick)
300 if (!MatchOnNickChange)
303 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
314 MODULE_INIT(ModuleRLine)