]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_messageflood.cpp
Sync helpop chmodes s and p with docs
[user/henk/code/inspircd.git] / src / modules / m_messageflood.cpp
index c37537249960eefa11849f4479207bc5cedcb329..329d77aac69ffc594c81a038faac2188ae294ff1 100644 (file)
@@ -1,19 +1,32 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2010 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ *   Copyright (C) 2013, 2017-2019 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012-2014, 2016 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2007 John Brooks <special@inspircd.org>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2006, 2008, 2010 Craig Edwards <brain@inspircd.org>
  *
- * 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"
 
-/* $ModDesc: Provides channel mode +f (message flood protection) */
+#include "inspircd.h"
+#include "modules/ctctags.h"
+#include "modules/exemption.h"
 
 /** Holds flood settings and state for mode +f
  */
@@ -21,207 +34,139 @@ class floodsettings
 {
  public:
        bool ban;
-       int secs;
-       int lines;
+       unsigned int secs;
+       unsigned int lines;
        time_t reset;
-       std::map<User*,int> counters;
+       insp::flat_map<User*, double> counters;
 
-       floodsettings(bool a, int b, int c) : ban(a), secs(b), lines(c)
+       floodsettings(bool a, unsigned int b, unsigned int c)
+               : ban(a)
+               , secs(b)
+               , lines(c)
        {
                reset = ServerInstance->Time() + secs;
-       };
+       }
 
-       void addmessage(User* who)
+       bool addmessage(User* who, double weight)
        {
-               std::map<User*,int>::iterator iter = counters.find(who);
-               if (iter != counters.end())
-               {
-                       iter->second++;
-               }
-               else
-               {
-                       counters[who] = 1;
-               }
                if (ServerInstance->Time() > reset)
                {
                        counters.clear();
                        reset = ServerInstance->Time() + secs;
                }
-       }
 
-       bool shouldkick(User* who)
-       {
-               std::map<User*,int>::iterator iter = counters.find(who);
-               if (iter != counters.end())
-               {
-                       return (iter->second >= this->lines);
-               }
-               else return false;
+               counters[who] += weight;
+               return (counters[who] >= this->lines);
        }
 
        void clear(User* who)
        {
-               std::map<User*,int>::iterator iter = counters.find(who);
-               if (iter != counters.end())
-               {
-                       counters.erase(iter);
-               }
+               counters.erase(who);
        }
 };
 
 /** Handles channel mode +f
  */
-class MsgFlood : public ModeHandler
+class MsgFlood : public ParamMode<MsgFlood, SimpleExtItem<floodsettings> >
 {
  public:
-       SimpleExtItem<floodsettings> ext;
-       MsgFlood(Module* Creator) : ModeHandler(Creator, "flood", 'f', PARAM_SETONLY, MODETYPE_CHANNEL),
-               ext("messageflood", Creator) { }
-
-       ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding)
+       MsgFlood(Module* Creator)
+               : ParamMode<MsgFlood, SimpleExtItem<floodsettings> >(Creator, "flood", 'f')
        {
-               floodsettings *f = ext.get(channel);
+               syntax = "[*]<messages>:<seconds>";
+       }
 
-               if (adding)
+       ModeAction OnSet(User* source, Channel* channel, std::string& parameter) CXX11_OVERRIDE
+       {
+               std::string::size_type colon = parameter.find(':');
+               if ((colon == std::string::npos) || (parameter.find('-') != std::string::npos))
                {
-                       char ndata[MAXBUF];
-                       char* data = ndata;
-                       strlcpy(ndata,parameter.c_str(),MAXBUF);
-                       char* lines = data;
-                       char* secs = NULL;
-                       bool ban = false;
-                       if (*data == '*')
-                       {
-                               ban = true;
-                               lines++;
-                       }
-                       else
-                       {
-                               ban = false;
-                       }
-                       while (*data)
-                       {
-                               if (*data == ':')
-                               {
-                                       *data = 0;
-                                       data++;
-                                       secs = data;
-                                       break;
-                               }
-                               else data++;
-                       }
-                       if (secs)
-                       {
-                               /* Set up the flood parameters for this channel */
-                               int nlines = atoi(lines);
-                               int nsecs = atoi(secs);
-                               if ((nlines<2) || (nsecs<1))
-                               {
-                                       source->WriteNumeric(608, "%s %s :Invalid flood parameter",source->nick.c_str(),channel->name.c_str());
-                                       parameter.clear();
-                                       return MODEACTION_DENY;
-                               }
-                               else
-                               {
-                                       if (!f)
-                                       {
-                                               parameter = std::string(ban ? "*" : "") + ConvToStr(nlines) + ":" +ConvToStr(nsecs);
-                                               f = new floodsettings(ban,nsecs,nlines);
-                                               ext.set(channel, f);
-                                               channel->SetModeParam('f', parameter);
-                                               return MODEACTION_ALLOW;
-                                       }
-                                       else
-                                       {
-                                               std::string cur_param = channel->GetModeParameter('f');
-                                               parameter = std::string(ban ? "*" : "") + ConvToStr(nlines) + ":" +ConvToStr(nsecs);
-                                               if (cur_param == parameter)
-                                               {
-                                                       // mode params match
-                                                       return MODEACTION_DENY;
-                                               }
-                                               else
-                                               {
-                                                       if ((((nlines != f->lines) || (nsecs != f->secs) || (ban != f->ban))) && (((nsecs > 0) && (nlines > 0))))
-                                                       {
-                                                               floodsettings *fs = new floodsettings(ban,nsecs,nlines);
-                                                               ext.set(channel, fs);
-                                                               channel->SetModeParam('f', parameter);
-                                                               return MODEACTION_ALLOW;
-                                                       }
-                                                       else
-                                                       {
-                                                               return MODEACTION_DENY;
-                                                       }
-                                               }
-                                       }
-                               }
-                       }
-                       else
-                       {
-                               source->WriteNumeric(608, "%s %s :Invalid flood parameter",source->nick.c_str(),channel->name.c_str());
-                               parameter.clear();
-                               return MODEACTION_DENY;
-                       }
+                       source->WriteNumeric(Numerics::InvalidModeParameter(channel, this, parameter));
+                       return MODEACTION_DENY;
                }
-               else
+
+               /* Set up the flood parameters for this channel */
+               bool ban = (parameter[0] == '*');
+               unsigned int nlines = ConvToNum<unsigned int>(parameter.substr(ban ? 1 : 0, ban ? colon-1 : colon));
+               unsigned int nsecs = ConvToNum<unsigned int>(parameter.substr(colon+1));
+
+               if ((nlines<2) || (nsecs<1))
                {
-                       if (f)
-                       {
-                               ext.unset(channel);
-                               channel->SetModeParam('f', "");
-                               return MODEACTION_ALLOW;
-                       }
+                       source->WriteNumeric(Numerics::InvalidModeParameter(channel, this, parameter));
+                       return MODEACTION_DENY;
                }
 
-               return MODEACTION_DENY;
+               ext.set(channel, new floodsettings(ban, nsecs, nlines));
+               return MODEACTION_ALLOW;
+       }
+
+       void SerializeParam(Channel* chan, const floodsettings* fs, std::string& out)
+       {
+               if (fs->ban)
+                       out.push_back('*');
+               out.append(ConvToStr(fs->lines)).push_back(':');
+               out.append(ConvToStr(fs->secs));
        }
 };
 
-class ModuleMsgFlood : public Module
+class ModuleMsgFlood
+       : public Module
+       , public CTCTags::EventListener
 {
+private:
+       CheckExemption::EventProvider exemptionprov;
        MsgFlood mf;
+       double notice;
+       double privmsg;
+       double tagmsg;
 
  public:
-
        ModuleMsgFlood()
-               : mf(this)
+               : CTCTags::EventListener(this)
+               , exemptionprov(this)
+               , mf(this)
        {
-               if (!ServerInstance->Modes->AddMode(&mf))
-                       throw ModuleException("Could not add new modes!");
-               ServerInstance->Extensions.Register(&mf.ext);
-               Implementation eventlist[] = { I_OnUserPreNotice, I_OnUserPreMessage };
-               ServerInstance->Modules->Attach(eventlist, this, 2);
        }
 
-       ModResult ProcessMessages(User* user,Channel* dest, const std::string &text)
+       void ReadConfig(ConfigStatus&) CXX11_OVERRIDE
        {
-               ModResult res;
-               FIRST_MOD_RESULT(OnChannelRestrictionApply, res, (user,dest,"flood"));
-               if (!IS_LOCAL(user) || res == MOD_RES_ALLOW)
+               ConfigTag* tag = ServerInstance->Config->ConfValue("messageflood");
+               notice = tag->getFloat("notice", 1.0);
+               privmsg = tag->getFloat("privmsg", 1.0);
+               tagmsg = tag->getFloat("tagmsg", 0.2);
+       }
+
+       ModResult HandleMessage(User* user, const MessageTarget& target, double weight)
+       {
+               if (target.type != MessageTarget::TYPE_CHANNEL)
+                       return MOD_RES_PASSTHRU;
+
+               Channel* dest = target.Get<Channel>();
+               if ((!IS_LOCAL(user)) || !dest->IsModeSet(mf))
+                       return MOD_RES_PASSTHRU;
+
+               ModResult res = CheckExemption::Call(exemptionprov, user, dest, "flood");
+               if (res == MOD_RES_ALLOW)
                        return MOD_RES_PASSTHRU;
 
                floodsettings *f = mf.ext.get(dest);
                if (f)
                {
-                       f->addmessage(user);
-                       if (f->shouldkick(user))
+                       if (f->addmessage(user, weight))
                        {
                                /* Youre outttta here! */
                                f->clear(user);
                                if (f->ban)
                                {
-                                       std::vector<std::string> parameters;
-                                       parameters.push_back(dest->name);
-                                       parameters.push_back("+b");
-                                       parameters.push_back(user->MakeWildHost());
-                                       ServerInstance->SendGlobalMode(parameters, ServerInstance->FakeClient);
+                                       Modes::ChangeList changelist;
+                                       changelist.push_add(ServerInstance->Modes->FindMode('b', MODETYPE_CHANNEL), "*!*@" + user->GetDisplayedHost());
+                                       ServerInstance->Modes->Process(ServerInstance->FakeClient, dest, NULL, changelist);
                                }
 
-                               char kickmessage[MAXBUF];
-                               snprintf(kickmessage, MAXBUF, "Channel flood triggered (limit is %d lines in %d secs)", f->lines, f->secs);
+                               const std::string kickMessage = "Channel flood triggered (trigger is " + ConvToStr(f->lines) +
+                                       " lines in " + ConvToStr(f->secs) + " secs)";
 
-                               dest->KickUser(ServerInstance->FakeClient, user, kickmessage);
+                               dest->KickUser(ServerInstance->FakeClient, user, kickMessage);
 
                                return MOD_RES_DENY;
                        }
@@ -230,29 +175,25 @@ class ModuleMsgFlood : public Module
                return MOD_RES_PASSTHRU;
        }
 
-       ModResult OnUserPreMessage(User *user, void *dest, int target_type, std::string &text, char status, CUList &exempt_list)
+       ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details) CXX11_OVERRIDE
        {
-               if (target_type == TYPE_CHANNEL)
-                       return ProcessMessages(user,(Channel*)dest,text);
-
-               return MOD_RES_PASSTHRU;
+               return HandleMessage(user, target, (details.type == MSG_PRIVMSG ? privmsg : notice));
        }
 
-       ModResult OnUserPreNotice(User *user, void *dest, int target_type, std::string &text, char status, CUList &exempt_list)
+       ModResult OnUserPreTagMessage(User* user, const MessageTarget& target, CTCTags::TagMessageDetails& details) CXX11_OVERRIDE
        {
-               if (target_type == TYPE_CHANNEL)
-                       return ProcessMessages(user,(Channel*)dest,text);
-
-               return MOD_RES_PASSTHRU;
+               return HandleMessage(user, target, tagmsg);
        }
 
-       ~ModuleMsgFlood()
+       void Prioritize() CXX11_OVERRIDE
        {
+               // we want to be after all modules that might deny the message (e.g. m_muteban, m_noctcp, m_blockcolor, etc.)
+               ServerInstance->Modules->SetPriority(this, I_OnUserPreMessage, PRIORITY_LAST);
        }
 
-       Version GetVersion()
+       Version GetVersion() CXX11_OVERRIDE
        {
-               return Version("Provides channel mode +f (message flood protection)", VF_VENDOR);
+               return Version("Adds channel mode f (flood) which helps protect against spammers which mass-message channels.", VF_VENDOR);
        }
 };