]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_rline.cpp
Merge pull request #984 from Renegade334/modules-exempt-uline
[user/henk/code/inspircd.git] / src / modules / m_rline.cpp
index 7397beebd1483b3ecc2d6edb51abfea047cad79c..2aee89ad282b300053dbbf4aca3adb93a49c94bc 100644 (file)
@@ -1,31 +1,35 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ *   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>
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * 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 free but copyrighted software; see
- *         the file COPYING for details.
+ * 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 "modules/regex.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
+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,157 +39,305 @@ 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;
        }
 
-       virtual bool Matches(User *u)
+       bool Matches(User *u)
        {
-               std::string compare = compare.assign(u->nick) + "!" + u->ident + "@" + u->host + " " + u->fullname;
-
-               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;
-               }
+               LocalUser* lu = IS_LOCAL(u);
+               if (lu && lu->exempt)
+                       return false;
 
-               return false;
+               std::string compare = u->nick + "!" + u->ident + "@" + u->host + " " + u->fullname;
+               return regex->Matches(compare);
        }
 
-       virtual bool Matches(const std::string&); // Ignored for us
-
-       virtual void Apply(User* u)
+       bool Matches(const std::string &compare)
        {
-               DefaultApply(u, "R", true);
+               return regex->Matches(compare);
        }
 
-       virtual void DisplayExpiry()
+       void Apply(User* u)
        {
-               ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed R-Line %s (set by %s %d seconds ago)", this->matchtext.c_str(), this->source, this->duration);
+               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);
        }
 
-       virtual const char* Displayable()
+       const std::string& Displayable()
        {
-               return matchtext.c_str();
+               return matchtext;
        }
 
        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)
-        {
-                return new RLine(ServerInstance, set_time, duration, source, reason, xline_specific_mask);
-        }
-};
-
-/*
-       if (pcnt >= 3)
+       XLine* Generate(time_t set_time, long duration, std::string source, std::string reason, std::string xline_specific_mask)
        {
-               IdentHostPair ih;
-               User* find = ServerInstance->FindNick(parameters[0]);
-               if (find)
+               if (!rxfactory)
                {
-                       ih.first = "*";
-                       ih.second = find->GetIPString();
+                       ServerInstance->SNO->WriteToSnoMask('a', "Cannot create regexes until engine is set to a loaded provider!");
+                       throw ModuleException("Regex engine not set or loaded!");
                }
-               else
-                       ih = ServerInstance->XLines->IdentSplit(parameters[0]);
 
-               if (ServerInstance->HostMatchesEveryone(ih.first+"@"+ih.second,user))
-                       return CMD_FAILURE;
+               return new RLine(set_time, duration, source, reason, xline_specific_mask, rxfactory);
+       }
+};
 
-               if (!strchr(parameters[0],'@'))
-               {       
-                       user->WriteServ("NOTICE %s :*** G-Line must contain a username, e.g. *@%s",user->nick,parameters[0]);
-                       return CMD_FAILURE;
-               }
-               else if (strchr(parameters[0],'!'))
+/** Handle /RLINE
+ * Syntax is same as other lines: RLINE regex_goes_here 1d :reason
+ */
+class CommandRLine : public Command
+{
+       std::string rxengine;
+       RLineFactory& factory;
+
+ public:
+       CommandRLine(Module* Creator, RLineFactory& rlf) : Command(Creator,"RLINE", 1, 3), factory(rlf)
+       {
+               flags_needed = 'o'; this->syntax = "<regex> [<rline-duration>] :<reason>";
+       }
+
+       CmdResult Handle (const std::vector<std::string>& parameters, User *user)
+       {
+
+               if (parameters.size() >= 3)
                {
-                       user->WriteServ("NOTICE %s :*** G-Line cannot contain a nickname!",user->nick);
-                       return CMD_FAILURE;
-               }
+                       // Adding - XXX todo make this respect <insane> tag perhaps..
 
-               long duration = ServerInstance->Duration(parameters[1]);
-               GLine* gl = new GLine(ServerInstance, ServerInstance->Time(), duration, user->nick, parameters[2], ih.first.c_str(), ih.second.c_str());
-               if (ServerInstance->XLines->AddLine(gl, user))
+                       unsigned long duration = InspIRCd::Duration(parameters[1]);
+                       XLine *r = NULL;
+
+                       try
+                       {
+                               r = factory.Generate(ServerInstance->Time(), duration, user->nick.c_str(), parameters[2].c_str(), parameters[0].c_str());
+                       }
+                       catch (ModuleException &e)
+                       {
+                               ServerInstance->SNO->WriteToSnoMask('a',"Could not add RLINE: " + e.GetReason());
+                       }
+
+                       if (r)
+                       {
+                               if (ServerInstance->XLines->AddLine(r, user))
+                               {
+                                       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());
+                                       }
+                                       else
+                                       {
+                                               time_t c_requires_crap = duration + ServerInstance->Time();
+                                               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();
+                               }
+                               else
+                               {
+                                       delete r;
+                                       user->WriteNotice("*** R-Line for " + parameters[0] + " already exists");
+                               }
+                       }
+               }
+               else
                {
-                       if (!duration)
+                       if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "R", user))
                        {
-                               ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent G-line for %s.",user->nick,parameters[0]);
+                               ServerInstance->SNO->WriteToSnoMask('x',"%s removed R-line on %s",user->nick.c_str(),parameters[0].c_str());
                        }
                        else
                        {
-                               time_t c_requires_crap = duration + ServerInstance->Time();
-                               ServerInstance->SNO->WriteToSnoMask('x',"%s added timed G-line for %s, expires on %s",user->nick,parameters[0],
-                                               ServerInstance->TimeString(c_requires_crap).c_str());
+                               user->WriteNotice("*** R-Line " + parameters[0] + " not found in list, try /stats R.");
                        }
+               }
 
-                       ServerInstance->XLines->ApplyLines();
+               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
+{
+       dynamic_reference<RegexFactory> rxfactory;
+       RLineFactory f;
+       CommandRLine r;
+       bool MatchOnNickChange;
+       bool initing;
+       RegexFactory* factory;
+
+ public:
+       ModuleRLine()
+               : rxfactory(this, "regex"), f(rxfactory), r(this, f)
+               , initing(true)
+       {
+       }
+
+       void init() CXX11_OVERRIDE
+       {
+               ServerInstance->XLines->RegisterFactory(&f);
+       }
+
+       ~ModuleRLine()
+       {
+               ServerInstance->XLines->DelAll("R");
+               ServerInstance->XLines->UnregisterFactory(&f);
+       }
+
+       Version GetVersion() CXX11_OVERRIDE
+       {
+               return Version("RLINE: Regexp user banning.", VF_COMMON | VF_VENDOR, rxfactory ? rxfactory->name : "");
+       }
+
+       ModResult OnUserRegister(LocalUser* user) CXX11_OVERRIDE
+       {
+               // 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;
+       }
+
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
+       {
+               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)
                {
-                       delete gl;
-                       user->WriteServ("NOTICE %s :*** G-Line for %s already exists",user->nick,parameters[0]);
+                       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;
+       }
+
+       ModResult OnStats(char symbol, User* user, string_list &results) CXX11_OVERRIDE
+       {
+               if (symbol != 'R')
+                       return MOD_RES_PASSTHRU;
 
+               ServerInstance->XLines->InvokeStats("R", 223, user, results);
+               return MOD_RES_DENY;
        }
-       else
+
+       void OnUserPostNick(User *user, const std::string &oldnick) CXX11_OVERRIDE
        {
-               if (ServerInstance->XLines->DelLine(parameters[0],"G",user))
+               if (!IS_LOCAL(user))
+                       return;
+
+               if (!MatchOnNickChange)
+                       return;
+
+               XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
+
+               if (rl)
                {
-                       ServerInstance->SNO->WriteToSnoMask('x',"%s Removed G-line on %s.",user->nick,parameters[0]);
+                       // Bang! :D
+                       rl->Apply(user);
                }
-               else
+       }
+
+       void OnBackgroundTimer(time_t curtime) CXX11_OVERRIDE
+       {
+               if (added_zline)
                {
-                       user->WriteServ("NOTICE %s :*** G-line %s not found in list, try /stats g.",user->nick,parameters[0]);
+                       added_zline = false;
+                       ServerInstance->XLines->ApplyLines();
                }
        }
-*/
 
-class ModuleRLine : public Module
-{
- public:
-       ModuleRLine(InspIRCd* Me) : Module(Me)
+       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());
+               }
        }
 
-       virtual ~ModuleRLine()
+       void Prioritize()
        {
+               Module* mod = ServerInstance->Modules->Find("m_cgiirc.so");
+               ServerInstance->Modules->SetPriority(this, I_OnUserRegister, PRIORITY_AFTER, mod);
        }
 };
 
 MODULE_INIT(ModuleRLine)
-