]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_rline.cpp
Introduce Stats::Context, pass it to the OnStats hook and switch all code to it
[user/henk/code/inspircd.git] / src / modules / m_rline.cpp
index 2394efaa37c7bec2103ea2fa2ebc3b3486f79e9e..97fbf169a2b13247fb3511fefc38a50b8b846f76 100644 (file)
@@ -1,24 +1,31 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
  *
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
  *
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+
 #include "inspircd.h"
-#include "m_regex.h"
+#include "modules/regex.h"
 #include "xline.h"
 
-static Module* rxengine = NULL;
-static Module* mymodule = NULL; /* Needed to let RLine send request! */
-
-/* $ModDesc: RLINE: Regexp user banning. */
+static bool ZlineOnMatch = false;
+static bool added_zline = false;
 
 class RLine : public XLine
 {
@@ -32,20 +39,14 @@ class RLine : public XLine
         * @param regex Pattern to match with
         * @
         */
-       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")
+       RLine(time_t s_time, long d, const std::string& src, const std::string& re, const std::string& regexs, dynamic_reference<RegexFactory>& rxfactory)
+               : XLine(s_time, d, src, re, "R")
+               , matchtext(regexs)
        {
-               matchtext = regexs;
-
-               if (!rxengine)
-               {
-                       ServerInstance->SNO->WriteToSnoMask('x', "Cannot create regexes until engine is set to a loaded provider!");
-                       throw ModuleException("Regex engine not set or loaded!");
-               }
-
                /* This can throw on failure, but if it does we DONT catch it here, we catch it and display it
                 * where the object is created, we might not ALWAYS want it to output stuff to snomask x all the time
                 */
-               regex = RegexFactoryRequest(mymodule, rxengine, regexs).Create();
+               regex = rxfactory->Create(regexs);
        }
 
        /** Destructor
@@ -57,7 +58,8 @@ class RLine : public XLine
 
        bool Matches(User *u)
        {
-               if (u->exempt)
+               LocalUser* lu = IS_LOCAL(u);
+               if (lu && lu->exempt)
                        return false;
 
                std::string compare = u->nick + "!" + u->ident + "@" + u->host + " " + u->fullname;
@@ -71,17 +73,25 @@ class RLine : public XLine
 
        void Apply(User* u)
        {
-               DefaultApply(u, "R", true);
-       }
-
-       void DisplayExpiry()
-       {
-               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));
+               if (ZlineOnMatch)
+               {
+                       ZLine* zl = new ZLine(ServerInstance->Time(), duration ? expiry - ServerInstance->Time() : 0, ServerInstance->Config->ServerName.c_str(), reason.c_str(), u->GetIPString());
+                       if (ServerInstance->XLines->AddLine(zl, NULL))
+                       {
+                               std::string timestr = InspIRCd::TimeString(zl->expiry);
+                               ServerInstance->SNO->WriteToSnoMask('x', "Z-line added due to R-line match on *@%s%s%s: %s",
+                                       zl->ipaddr.c_str(), zl->duration ? " to expire on " : "", zl->duration ? timestr.c_str() : "", zl->reason.c_str());
+                               added_zline = true;
+                       }
+                       else
+                               delete zl;
+               }
+               DefaultApply(u, "R", false);
        }
 
-       const char* Displayable()
+       const std::string& Displayable()
        {
-               return matchtext.c_str();
+               return matchtext;
        }
 
        std::string matchtext;
@@ -95,19 +105,22 @@ class RLine : public XLine
 class RLineFactory : public XLineFactory
 {
  public:
-       RLineFactory(InspIRCd* Instance) : XLineFactory(Instance, "R")
+       dynamic_reference<RegexFactory>& rxfactory;
+       RLineFactory(dynamic_reference<RegexFactory>& rx) : XLineFactory("R"), rxfactory(rx)
        {
        }
 
        /** Generate a RLine
         */
-       XLine* Generate(time_t set_time, long duration, const char* source, const char* reason, const char* xline_specific_mask)
+       XLine* Generate(time_t set_time, long duration, std::string source, std::string reason, std::string xline_specific_mask)
        {
-               return new RLine(ServerInstance, set_time, duration, source, reason, xline_specific_mask);
-       }
+               if (!rxfactory)
+               {
+                       ServerInstance->SNO->WriteToSnoMask('a', "Cannot create regexes until engine is set to a loaded provider!");
+                       throw ModuleException("Regex engine not set or loaded!");
+               }
 
-       ~RLineFactory()
-       {
+               return new RLine(set_time, duration, source, reason, xline_specific_mask, rxfactory);
        }
 };
 
@@ -117,12 +130,12 @@ class RLineFactory : public XLineFactory
 class CommandRLine : public Command
 {
        std::string rxengine;
+       RLineFactory& factory;
 
  public:
-       CommandRLine (InspIRCd* Instance) : Command(Instance,"RLINE", "o", 1, 3)
+       CommandRLine(Module* Creator, RLineFactory& rlf) : Command(Creator,"RLINE", 1, 3), factory(rlf)
        {
-               this->source = "m_rline.so";
-               this->syntax = "<regex> [<rline-duration>] :<reason>";
+               flags_needed = 'o'; this->syntax = "<regex> [<rline-duration>] :<reason>";
        }
 
        CmdResult Handle (const std::vector<std::string>& parameters, User *user)
@@ -132,16 +145,16 @@ class CommandRLine : public Command
                {
                        // Adding - XXX todo make this respect <insane> tag perhaps..
 
-                       long duration = ServerInstance->Duration(parameters[1]);
-                       RLine *r = NULL;
+                       unsigned long duration = InspIRCd::Duration(parameters[1]);
+                       XLine *r = NULL;
 
                        try
                        {
-                               r = new RLine(ServerInstance, ServerInstance->Time(), duration, user->nick.c_str(), parameters[2].c_str(), parameters[0].c_str());
+                               r = factory.Generate(ServerInstance->Time(), duration, user->nick.c_str(), parameters[2].c_str(), parameters[0].c_str());
                        }
                        catch (ModuleException &e)
                        {
-                               ServerInstance->SNO->WriteToSnoMask('x',"Could not add RLINE: %s", e.GetReason());
+                               ServerInstance->SNO->WriteToSnoMask('a',"Could not add RLINE: " + e.GetReason());
                        }
 
                        if (r)
@@ -150,12 +163,13 @@ class CommandRLine : public Command
                                {
                                        if (!duration)
                                        {
-                                               ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent R-Line for %s: %s", user->nick.c_str(), parameters[0].c_str(), parameters[2].c_str());
+                                               ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent R-line for %s: %s", user->nick.c_str(), parameters[0].c_str(), parameters[2].c_str());
                                        }
                                        else
                                        {
                                                time_t c_requires_crap = duration + ServerInstance->Time();
-                                               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());
+                                               std::string timestr = InspIRCd::TimeString(c_requires_crap);
+                                               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());
                                        }
 
                                        ServerInstance->XLines->ApplyLines();
@@ -163,7 +177,7 @@ class CommandRLine : public Command
                                else
                                {
                                        delete r;
-                                       user->WriteServ("NOTICE %s :*** R-Line for %s already exists", user->nick.c_str(), parameters[0].c_str());
+                                       user->WriteNotice("*** R-Line for " + parameters[0] + " already exists");
                                }
                        }
                }
@@ -171,59 +185,59 @@ class CommandRLine : public Command
                {
                        if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "R", user))
                        {
-                               ServerInstance->SNO->WriteToSnoMask('x',"%s Removed R-Line on %s.",user->nick.c_str(),parameters[0].c_str());
+                               ServerInstance->SNO->WriteToSnoMask('x',"%s removed R-line on %s",user->nick.c_str(),parameters[0].c_str());
                        }
                        else
                        {
-                               user->WriteServ("NOTICE %s :*** R-Line %s not found in list, try /stats R.",user->nick.c_str(),parameters[0].c_str());
+                               user->WriteNotice("*** R-Line " + parameters[0] + " not found in list, try /stats R.");
                        }
                }
 
                return CMD_SUCCESS;
        }
+
+       RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
+       {
+               if (IS_LOCAL(user))
+                       return ROUTE_LOCALONLY; // spanningtree will send ADDLINE
+
+               return ROUTE_BROADCAST;
+       }
 };
 
 class ModuleRLine : public Module
 {
- private:
-       CommandRLine *r;
-       RLineFactory *f;
+       dynamic_reference<RegexFactory> rxfactory;
+       RLineFactory f;
+       CommandRLine r;
        bool MatchOnNickChange;
-       std::string RegexEngine;
+       bool initing;
+       RegexFactory* factory;
 
  public:
-       ModuleRLine(InspIRCd* Me) : Module(Me)
+       ModuleRLine()
+               : rxfactory(this, "regex"), f(rxfactory), r(this, f)
+               , initing(true)
        {
-               mymodule = this;
-               OnRehash(NULL, "");
-
-               Me->Modules->UseInterface("RegularExpression");
-
-               // Create a new command
-               r = new CommandRLine(ServerInstance);
-               ServerInstance->AddCommand(r);
-
-               f = new RLineFactory(ServerInstance);
-               ServerInstance->XLines->RegisterFactory(f);
-
-               Implementation eventlist[] = { I_OnUserConnect, I_OnRehash, I_OnUserPostNick, I_OnLoadModule, I_OnStats };
-               ServerInstance->Modules->Attach(eventlist, this, 5);
+       }
 
+       void init() CXX11_OVERRIDE
+       {
+               ServerInstance->XLines->RegisterFactory(&f);
        }
 
-       virtual ~ModuleRLine()
+       ~ModuleRLine()
        {
-               ServerInstance->Modules->DoneWithInterface("RegularExpression");
                ServerInstance->XLines->DelAll("R");
-               ServerInstance->XLines->UnregisterFactory(f);
+               ServerInstance->XLines->UnregisterFactory(&f);
        }
 
-       virtual Version GetVersion()
+       Version GetVersion() CXX11_OVERRIDE
        {
-               return Version("$Id$", VF_COMMON | VF_VENDOR, API_VERSION);
+               return Version("RLINE: Regexp user banning.", VF_COMMON | VF_VENDOR, rxfactory ? rxfactory->name : "");
        }
 
-       virtual void OnUserConnect(User* user)
+       ModResult OnUserRegister(LocalUser* user) CXX11_OVERRIDE
        {
                // Apply lines on user connect
                XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
@@ -232,67 +246,54 @@ class ModuleRLine : public Module
                {
                        // Bang. :P
                        rl->Apply(user);
+                       return MOD_RES_DENY;
                }
+               return MOD_RES_PASSTHRU;
        }
 
-       virtual void OnRehash(User *user, const std::string &parameter)
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
        {
-               ConfigReader Conf(ServerInstance);
+               ConfigTag* tag = ServerInstance->Config->ConfValue("rline");
 
-               MatchOnNickChange = Conf.ReadFlag("rline", "matchonnickchange", 0);
-               std::string newrxengine = Conf.ReadValue("rline", "engine", 0);
+               MatchOnNickChange = tag->getBool("matchonnickchange");
+               ZlineOnMatch = tag->getBool("zlineonmatch");
+               std::string newrxengine = tag->getString("engine");
 
-               if (!RegexEngine.empty())
-               {
-                       if (RegexEngine == newrxengine)
-                               return;
+               factory = rxfactory ? (rxfactory.operator->()) : NULL;
 
-                       ServerInstance->SNO->WriteToSnoMask('x', "Dumping all R-Lines due to regex engine change (was '%s', now '%s')", RegexEngine.c_str(), newrxengine.c_str());
-                       ServerInstance->XLines->DelAll("R");
-               }
-               rxengine = 0;
-               RegexEngine = newrxengine;
-               modulelist* ml = ServerInstance->Modules->FindInterface("RegularExpression");
-               if (ml)
+               if (newrxengine.empty())
+                       rxfactory.SetProvider("regex");
+               else
+                       rxfactory.SetProvider("regex/" + newrxengine);
+
+               if (!rxfactory)
                {
-                       for (modulelist::iterator i = ml->begin(); i != ml->end(); ++i)
-                       {
-                               if (RegexNameRequest(this, *i).Send() == newrxengine)
-                               {
-                                       ServerInstance->SNO->WriteToSnoMask('x', "R-Line now using engine '%s'", RegexEngine.c_str());
-                                       rxengine = *i;
-                               }
-                       }
+                       if (newrxengine.empty())
+                               ServerInstance->SNO->WriteToSnoMask('a', "WARNING: No regex engine loaded - R-Line functionality disabled until this is corrected.");
+                       else
+                               ServerInstance->SNO->WriteToSnoMask('a', "WARNING: Regex engine '%s' is not loaded - R-Line functionality disabled until this is corrected.", newrxengine.c_str());
+
+                       ServerInstance->XLines->DelAll(f.GetType());
                }
-               if (!rxengine)
+               else if ((!initing) && (rxfactory.operator->() != factory))
                {
-                       ServerInstance->SNO->WriteToSnoMask('x', "WARNING: Regex engine '%s' is not loaded - R-Line functionality disabled until this is corrected.", RegexEngine.c_str());
+                       ServerInstance->SNO->WriteToSnoMask('a', "Regex engine has changed, removing all R-Lines");
+                       ServerInstance->XLines->DelAll(f.GetType());
                }
-       }
-
-       virtual int OnStats(char symbol, User* user, string_list &results)
-       {
-               if (symbol != 'R')
-                       return 0;
 
-               ServerInstance->XLines->InvokeStats("R", 223, user, results);
-               return 1;
+               initing = false;
        }
 
-       virtual void OnLoadModule(Module* mod, const std::string& name)
+       ModResult OnStats(Stats::Context& stats) CXX11_OVERRIDE
        {
-               if (ServerInstance->Modules->ModuleHasInterface(mod, "RegularExpression"))
-               {
-                       std::string rxname = RegexNameRequest(this, mod).Send();
-                       if (rxname == RegexEngine)
-                       {
-                               ServerInstance->SNO->WriteToSnoMask('x', "R-Line now using engine '%s'", RegexEngine.c_str());
-                               rxengine = mod;
-                       }
-               }
+               if (stats.GetSymbol() != 'R')
+                       return MOD_RES_PASSTHRU;
+
+               ServerInstance->XLines->InvokeStats("R", 223, stats);
+               return MOD_RES_DENY;
        }
 
-       virtual void OnUserPostNick(User *user, const std::string &oldnick)
+       void OnUserPostNick(User *user, const std::string &oldnick) CXX11_OVERRIDE
        {
                if (!IS_LOCAL(user))
                        return;
@@ -309,7 +310,34 @@ class ModuleRLine : public Module
                }
        }
 
+       void OnBackgroundTimer(time_t curtime) CXX11_OVERRIDE
+       {
+               if (added_zline)
+               {
+                       added_zline = false;
+                       ServerInstance->XLines->ApplyLines();
+               }
+       }
+
+       void OnUnloadModule(Module* mod) CXX11_OVERRIDE
+       {
+               // If the regex engine became unavailable or has changed, remove all rlines
+               if (!rxfactory)
+               {
+                       ServerInstance->XLines->DelAll(f.GetType());
+               }
+               else if (rxfactory.operator->() != factory)
+               {
+                       factory = rxfactory.operator->();
+                       ServerInstance->XLines->DelAll(f.GetType());
+               }
+       }
+
+       void Prioritize()
+       {
+               Module* mod = ServerInstance->Modules->Find("m_cgiirc.so");
+               ServerInstance->Modules->SetPriority(this, I_OnUserRegister, PRIORITY_AFTER, mod);
+       }
 };
 
 MODULE_INIT(ModuleRLine)
-