]> 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 6cae0badf40198d8730bfb6dd096e99a318fcd12..2aee89ad282b300053dbbf4aca3adb93a49c94bc 100644 (file)
-/*       +------------------------------------+
- *       | 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 "users.h"
-#include "channels.h"
-#include "modules.h"
-#include "m_filter.h"
-
-/* $ModDesc: m_filter with regexps */
-/* $CompileFlags: exec("pcre-config --cflags") */
-/* $LinkerFlags: exec("pcre-config --libs") rpath("pcre-config --libs") -lpcre */
-/* $ModDep: m_filter.h */
-
-#ifdef WINDOWS
-#pragma comment(lib, "pcre.lib")
-#endif
-
-class PCREFilter : public FilterResult
+#include "modules/regex.h"
+#include "xline.h"
+
+static bool ZlineOnMatch = false;
+static bool added_zline = false;
+
+class RLine : public XLine
 {
  public:
-        pcre* regexp;
 
-        PCREFilter(pcre* r, const std::string &rea, const std::string &act, long gline_time, const std::string &pat, const std::string &flags)
-                : FilterResult(pat, rea, act, gline_time, flags), regexp(r)
-        {
-        }
+       /** Create a R-Line.
+        * @param s_time The set time
+        * @param d The duration of the xline
+        * @param src The sender of the xline
+        * @param re The reason of the xline
+        * @param regex Pattern to match with
+        * @
+        */
+       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)
+       {
+               /* 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);
+       }
 
-        PCREFilter()
-        {
-        }
+       /** Destructor
+        */
+       ~RLine()
+       {
+               delete regex;
+       }
+
+       bool Matches(User *u)
+       {
+               LocalUser* lu = IS_LOCAL(u);
+               if (lu && lu->exempt)
+                       return false;
+
+               std::string compare = u->nick + "!" + u->ident + "@" + u->host + " " + u->fullname;
+               return regex->Matches(compare);
+       }
+
+       bool Matches(const std::string &compare)
+       {
+               return regex->Matches(compare);
+       }
+
+       void Apply(User* u)
+       {
+               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 std::string& Displayable()
+       {
+               return matchtext;
+       }
+
+       std::string matchtext;
+
+       Regex *regex;
 };
 
-class ModuleFilterPCRE : public FilterBase
-{
-       std::vector<PCREFilter> filters;
-       pcre *re;
-       const char *error;
-       int erroffset;
-       PCREFilter fr;
 
+/** An XLineFactory specialized to generate RLine* pointers
+ */
+class RLineFactory : public XLineFactory
+{
  public:
-       ModuleFilterPCRE(InspIRCd* Me)
-       : FilterBase(Me, "m_filter_pcre.so")
+       dynamic_reference<RegexFactory>& rxfactory;
+       RLineFactory(dynamic_reference<RegexFactory>& rx) : XLineFactory("R"), rxfactory(rx)
        {
-               OnRehash(NULL,"");
+       }
+
+       /** Generate a RLine
+        */
+       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);
        }
+};
+
+/** Handle /RLINE
+ * Syntax is same as other lines: RLINE regex_goes_here 1d :reason
+ */
+class CommandRLine : public Command
+{
+       std::string rxengine;
+       RLineFactory& factory;
 
-       virtual ~ModuleFilterPCRE()
+ public:
+       CommandRLine(Module* Creator, RLineFactory& rlf) : Command(Creator,"RLINE", 1, 3), factory(rlf)
        {
+               flags_needed = 'o'; this->syntax = "<regex> [<rline-duration>] :<reason>";
        }
 
-       virtual FilterResult* FilterMatch(User* user, const std::string &text, int flags)
+       CmdResult Handle (const std::vector<std::string>& parameters, User *user)
        {
-               for (std::vector<PCREFilter>::iterator index = filters.begin(); index != filters.end(); index++)
+
+               if (parameters.size() >= 3)
                {
-                       /* Skip ones that dont apply to us */
+                       // Adding - XXX todo make this respect <insane> tag perhaps..
+
+                       unsigned long duration = InspIRCd::Duration(parameters[1]);
+                       XLine *r = NULL;
 
-                       if (!FilterBase::AppliesToMe(user, dynamic_cast<FilterResult*>(&(*index)), flags))
-                               continue;
+                       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 (pcre_exec(index->regexp, NULL, text.c_str(), text.length(), 0, 0, NULL, 0) > -1)
+                       if (r)
                        {
-                               fr = *index;
-                               if (index != filters.begin())
+                               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
                                {
-                                       filters.erase(index);
-                                       filters.insert(filters.begin(), fr);
+                                       delete r;
+                                       user->WriteNotice("*** R-Line for " + parameters[0] + " already exists");
                                }
-                               return &fr;
                        }
                }
-               return NULL;
-       }
-
-       virtual bool DeleteFilter(const std::string &freeform)
-       {
-               for (std::vector<PCREFilter>::iterator i = filters.begin(); i != filters.end(); i++)
+               else
                {
-                       if (i->freeform == freeform)
+                       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());
+                       }
+                       else
                        {
-                               pcre_free((*i).regexp);
-                               filters.erase(i);
-                               return true;
+                               user->WriteNotice("*** R-Line " + parameters[0] + " not found in list, try /stats R.");
                        }
                }
-               return false;
+
+               return CMD_SUCCESS;
        }
 
-       virtual void SyncFilters(Module* proto, void* opaque)
+       RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
        {
-               for (std::vector<PCREFilter>::iterator i = filters.begin(); i != filters.end(); i++)
-               {
-                       this->SendFilter(proto, opaque, &(*i));
-               }
+               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;
 
-       virtual std::pair<bool, std::string> AddFilter(const std::string &freeform, const std::string &type, const std::string &reason, long duration, const std::string &flags)
+ public:
+       ModuleRLine()
+               : rxfactory(this, "regex"), f(rxfactory), r(this, f)
+               , initing(true)
        {
-               for (std::vector<PCREFilter>::iterator i = filters.begin(); i != filters.end(); i++)
+       }
+
+       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)
                {
-                       if (i->freeform == freeform)
-                       {
-                               return std::make_pair(false, "Filter already exists");
-                       }
+                       // 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");
 
-               re = pcre_compile(freeform.c_str(),0,&error,&erroffset,NULL);
+               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 (!re)
+               if (!rxfactory)
                {
-                       ServerInstance->Log(DEFAULT,"Error in regular expression: %s at offset %d: %s\n", freeform.c_str(), erroffset, error);
-                       ServerInstance->Log(DEFAULT,"Regular expression %s not loaded.", freeform.c_str());
-                       return std::make_pair(false, "Error in regular expression at offset " + ConvToStr(erroffset) + ": "+error);
+                       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
+               else if ((!initing) && (rxfactory.operator->() != factory))
                {
-                       filters.push_back(PCREFilter(re, reason, type, duration, freeform, flags));
-                       return std::make_pair(true, "");
+                       ServerInstance->SNO->WriteToSnoMask('a', "Regex engine has changed, removing all R-Lines");
+                       ServerInstance->XLines->DelAll(f.GetType());
                }
+
+               initing = false;
        }
 
-       virtual void OnRehash(User* user, const std::string &parameter)
-       {               
-               ConfigReader MyConf(ServerInstance);
+       ModResult OnStats(char symbol, User* user, string_list &results) CXX11_OVERRIDE
+       {
+               if (symbol != 'R')
+                       return MOD_RES_PASSTHRU;
 
-               for (int index = 0; index < MyConf.Enumerate("keyword"); index++)
-               {
-                       this->DeleteFilter(MyConf.ReadValue("keyword", "pattern", index));
+               ServerInstance->XLines->InvokeStats("R", 223, user, results);
+               return MOD_RES_DENY;
+       }
 
-                       std::string pattern = MyConf.ReadValue("keyword", "pattern", index);
-                       std::string reason = MyConf.ReadValue("keyword", "reason", index);
-                       std::string action = MyConf.ReadValue("keyword", "action", index);
-                       std::string flags = MyConf.ReadValue("keyword", "flags", index);
-                       long gline_time = ServerInstance->Duration(MyConf.ReadValue("keyword", "duration", index));
-                       if (action.empty())
-                               action = "none";
-                       if (flags.empty())
-                               flags = "*";
+       void OnUserPostNick(User *user, const std::string &oldnick) CXX11_OVERRIDE
+       {
+               if (!IS_LOCAL(user))
+                       return;
 
-                       re = pcre_compile(pattern.c_str(),0,&error,&erroffset,NULL);
+               if (!MatchOnNickChange)
+                       return;
 
-                       if (!re)
-                       {
-                               ServerInstance->Log(DEFAULT,"Error in regular expression: %s at offset %d: %s\n", pattern.c_str(), erroffset, error);
-                               ServerInstance->Log(DEFAULT,"Regular expression %s not loaded.", pattern.c_str());
-                       }
-                       else
-                       {
-                               filters.push_back(PCREFilter(re, reason, action, gline_time, pattern, flags));
-                               ServerInstance->Log(DEFAULT,"Regular expression %s loaded.", pattern.c_str());
-                       }
+               XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
+
+               if (rl)
+               {
+                       // Bang! :D
+                       rl->Apply(user);
                }
        }
 
-       virtual int OnStats(char symbol, User* user, string_list &results)
+       void OnBackgroundTimer(time_t curtime) CXX11_OVERRIDE
        {
-               if (symbol == 's')
+               if (added_zline)
                {
-                       std::string sn = ServerInstance->Config->ServerName;
-                       for (std::vector<PCREFilter>::iterator i = filters.begin(); i != filters.end(); i++)
-                       {
-                               results.push_back(sn+" 223 "+user->nick+" :REGEXP:"+i->freeform+" "+i->flags+" "+i->action+" "+ConvToStr(i->gline_time)+" :"+i->reason);
-                       }
+                       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());
                }
-               return 0;
        }
-};
 
-MODULE_INIT(ModuleFilterPCRE)
+       void Prioritize()
+       {
+               Module* mod = ServerInstance->Modules->Find("m_cgiirc.so");
+               ServerInstance->Modules->SetPriority(this, I_OnUserRegister, PRIORITY_AFTER, mod);
+       }
+};
 
+MODULE_INIT(ModuleRLine)