]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_rline.cpp
Merge pull request #1162 from SaberUK/insp20+fix-deinstall
[user/henk/code/inspircd.git] / src / modules / m_rline.cpp
index f526f4fd93f520ae44d0e893a2f620d359821259..d1ab5d9ba42cc35645ca77b54170a315f4319046 100644 (file)
@@ -1,31 +1,37 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/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 <pcre.h>
-#include "xline.h"
 
 /* $ModDesc: RLINE: Regexp user banning. */
-/* $CompileFlags: exec("pcre-config --cflags") */
-/* $LinkerFlags: exec("pcre-config --libs") rpath("pcre-config --libs") -lpcre */
 
-#ifdef WINDOWS
-#pragma comment(lib, "pcre.lib")
-#endif
+#include "inspircd.h"
+#include "m_regex.h"
+#include "xline.h"
+
+static bool ZlineOnMatch = false;
+static bool added_zline = false;
 
-class CoreExport RLine : public XLine
+class RLine : public XLine
 {
 public:
+ public:
 
        /** Create a R-Line.
         * @param s_time The set time
@@ -35,63 +41,59 @@ class CoreExport 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, "K")
+       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)
        {
-               const char *error;
-               int erroffset;
-
-               matchtext = regexs;
-
-               regex = pcre_compile(regexs, 0, &error, &erroffset, NULL);
-
-               if (!regex)
-               {
-                       ServerInstance->SNO->WriteToSnoMask('x',"Error in regular expression: %s at offset %d: %s\n", regexs, erroffset, error);
-                       throw CoreException("Bad regex pattern.");
-               }
+               /* 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 = rxfactory->Create(regexs);
        }
 
        /** Destructor
         */
        ~RLine()
        {
-               pcre_free(regex);
+               delete regex;
        }
 
        bool Matches(User *u)
        {
-               std::string compare = std::string(u->nick) + "!" + u->ident + "@" + u->host + " " + u->fullname;
+               if (u->exempt)
+                       return false;
 
-               ServerInstance->Log(DEBUG, "Matching " + matchtext + " against string " + compare);
-
-               if (pcre_exec(regex, NULL, compare.c_str(), compare.length(), 0, 0, NULL, 0) > -1)
-               {
-                       // Bang. :D
-                       return true;
-               }
-
-               return false;
+               std::string compare = u->nick + "!" + u->ident + "@" + u->host + " " + u->fullname;
+               return regex->Matches(compare);
        }
 
        bool Matches(const std::string &compare)
        {
-               if (pcre_exec(regex, NULL, compare.c_str(), compare.length(), 0, 0, NULL, 0) > -1)
-               {
-                       // Bang. :D
-                       return true;
-               }
-
-               return false;
+               return regex->Matches(compare);
        }
 
        void Apply(User* u)
        {
-               DefaultApply(u, "R", true);
+               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 = ServerInstance->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);
        }
 
        void DisplayExpiry()
        {
-               ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed R-Line %s (set by %s %d seconds ago)", this->matchtext.c_str(), this->source, this->duration);
+               ServerInstance->SNO->WriteToSnoMask('x',"Removing expired R-line %s (set by %s %ld seconds ago)",
+                       this->matchtext.c_str(), this->source.c_str(), (long int)(ServerInstance->Time() - this->set_time));
        }
 
        const char* Displayable()
@@ -101,22 +103,35 @@ class CoreExport RLine : public XLine
 
        std::string matchtext;
 
-       pcre *regex;
+       Regex *regex;
 };
 
 
 /** An XLineFactory specialized to generate RLine* pointers
  */
-class CoreExport RLineFactory : public XLineFactory
+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)
+       {
+               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!");
+               }
+
+               return new RLine(set_time, duration, source, reason, xline_specific_mask, rxfactory);
+       }
+
+       ~RLineFactory()
        {
-               return new RLine(ServerInstance, set_time, duration, source, reason, xline_specific_mask);
        }
 };
 
@@ -125,29 +140,32 @@ class CoreExport RLineFactory : public XLineFactory
  */
 class CommandRLine : public Command
 {
+       std::string rxengine;
+       RLineFactory& factory;
+
  public:
-       CommandRLine (InspIRCd* Instance) : Command(Instance,"RLINE", 'o', 1)
+       CommandRLine(Module* Creator, RLineFactory& rlf) : Command(Creator,"RLINE", 1, 3), factory(rlf)
        {
-               this->source = "m_rline.so";
+               flags_needed = 'o'; this->syntax = "<regex> [<rline-duration>] :<reason>";
        }
 
-       CmdResult Handle (const char** parameters, int pcnt, User *user)
+       CmdResult Handle (const std::vector<std::string>& parameters, User *user)
        {
 
-               if (pcnt >= 3)
+               if (parameters.size() >= 3)
                {
                        // Adding - XXX todo make this respect <insane> tag perhaps..
 
                        long duration = ServerInstance->Duration(parameters[1]);
-                       RLine *r = NULL;
+                       XLine *r = NULL;
 
                        try
                        {
-                               r = new RLine(ServerInstance, ServerInstance->Time(), duration, user->nick, parameters[2], parameters[0]);
+                               r = factory.Generate(ServerInstance->Time(), duration, user->nick.c_str(), parameters[2].c_str(), parameters[0].c_str());
                        }
-                       catch (...)
+                       catch (ModuleException &e)
                        {
-                               ; // Do nothing. If we get here, the regex was fucked up, and they already got told it fucked up.
+                               ServerInstance->SNO->WriteToSnoMask('a',"Could not add RLINE: %s", e.GetReason());
                        }
 
                        if (r)
@@ -156,13 +174,13 @@ class CommandRLine : public Command
                                {
                                        if (!duration)
                                        {
-                                               ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent R-Line for %s.", user->nick, parameters[0]);
+                                               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", user->nick, parameters[0],
-                                                               ServerInstance->TimeString(c_requires_crap).c_str());
+                                               std::string timestr = ServerInstance->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();
@@ -170,48 +188,174 @@ class CommandRLine : public Command
                                else
                                {
                                        delete r;
-                                       user->WriteServ("NOTICE %s :*** R-Line for %s already exists", user->nick, parameters[0]);
+                                       user->WriteServ("NOTICE %s :*** R-Line for %s already exists", user->nick.c_str(), parameters[0].c_str());
                                }
                        }
                }
                else
                {
-                       if (ServerInstance->XLines->DelLine(parameters[0], "R", user))
+                       if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "R", user))
                        {
-                               ServerInstance->SNO->WriteToSnoMask('x',"%s Removed R-Line on %s.",user->nick,parameters[0]);
+                               ServerInstance->SNO->WriteToSnoMask('x',"%s removed R-line on %s",user->nick.c_str(),parameters[0].c_str());
                        }
                        else
                        {
-                               // XXX todo implement stats
-                               user->WriteServ("NOTICE %s :*** R-Line %s not found in list, try /stats g.",user->nick,parameters[0]);
+                               user->WriteServ("NOTICE %s :*** R-Line %s not found in list, try /stats R.",user->nick.c_str(),parameters[0].c_str());
                        }
                }
 
                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;
+       dynamic_reference<RegexFactory> rxfactory;
+       RLineFactory f;
+       CommandRLine r;
+       bool MatchOnNickChange;
+       bool initing;
+       RegexFactory* factory;
+
  public:
-       ModuleRLine(InspIRCd* Me) : Module(Me)
+       ModuleRLine()
+               : rxfactory(this, "regex"), f(rxfactory), r(this, f)
+               , initing(true)
        {
-               // Create a new command
-               r = new CommandRLine(ServerInstance);
-               ServerInstance->AddCommand(r);
+       }
+
+       void init()
+       {
+               OnRehash(NULL);
+
+               ServerInstance->Modules->AddService(r);
+               ServerInstance->XLines->RegisterFactory(&f);
+
+               Implementation eventlist[] = { I_OnUserRegister, I_OnRehash, I_OnUserPostNick, I_OnStats, I_OnBackgroundTimer, I_OnUnloadModule };
+               ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
        }
 
        virtual ~ModuleRLine()
        {
+               ServerInstance->XLines->DelAll("R");
+               ServerInstance->XLines->UnregisterFactory(&f);
        }
 
        virtual Version GetVersion()
        {
-               return Version(1,1,0,0,VF_COMMON|VF_VENDOR,API_VERSION);
+               return Version("RLINE: Regexp user banning.", VF_COMMON | VF_VENDOR, rxfactory ? rxfactory->name : "");
+       }
+
+       ModResult OnUserRegister(LocalUser* user)
+       {
+               // Apply lines on user connect
+               XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
+
+               if (rl)
+               {
+                       // Bang. :P
+                       rl->Apply(user);
+                       return MOD_RES_DENY;
+               }
+               return MOD_RES_PASSTHRU;
+       }
+
+       virtual void OnRehash(User *user)
+       {
+               ConfigTag* tag = ServerInstance->Config->ConfValue("rline");
+
+               MatchOnNickChange = tag->getBool("matchonnickchange");
+               ZlineOnMatch = tag->getBool("zlineonmatch");
+               std::string newrxengine = tag->getString("engine");
+
+               factory = rxfactory ? (rxfactory.operator->()) : NULL;
+
+               if (newrxengine.empty())
+                       rxfactory.SetProvider("regex");
+               else
+                       rxfactory.SetProvider("regex/" + newrxengine);
+
+               if (!rxfactory)
+               {
+                       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());
+               }
+               else if ((!initing) && (rxfactory.operator->() != factory))
+               {
+                       ServerInstance->SNO->WriteToSnoMask('a', "Regex engine has changed, removing all R-Lines");
+                       ServerInstance->XLines->DelAll(f.GetType());
+               }
+
+               initing = false;
+       }
+
+       virtual ModResult OnStats(char symbol, User* user, string_list &results)
+       {
+               if (symbol != 'R')
+                       return MOD_RES_PASSTHRU;
+
+               ServerInstance->XLines->InvokeStats("R", 223, user, results);
+               return MOD_RES_DENY;
+       }
+
+       virtual void OnUserPostNick(User *user, const std::string &oldnick)
+       {
+               if (!IS_LOCAL(user))
+                       return;
+
+               if (!MatchOnNickChange)
+                       return;
+
+               XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
+
+               if (rl)
+               {
+                       // Bang! :D
+                       rl->Apply(user);
+               }
+       }
+
+       virtual void OnBackgroundTimer(time_t curtime)
+       {
+               if (added_zline)
+               {
+                       added_zline = false;
+                       ServerInstance->XLines->ApplyLines();
+               }
+       }
+
+       void OnUnloadModule(Module* mod)
+       {
+               // 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)
-