Sync helpop chmodes s and p with docs

[user/henk/code/inspircd.git] / src / modules / m_messageflood.cpp

diff --git a/src/modules/m_messageflood.cpp b/src/modules/m_messageflood.cpp
index 36f2c923b6779991bfecb152f8dff02568ddf43b..329d77aac69ffc594c81a038faac2188ae294ff1 100644 (file)
--- a/src/modules/m_messageflood.cpp
+++ b/src/modules/m_messageflood.cpp
@@ -1,13 +1,14 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
+ *   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) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
- *   Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
- *   Copyright (C) 2007 John Brooks <john.brooks@dereferenced.net>
+ *   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 Craig Edwards <craigedwards@brainbox.cc>
- *   Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
+ *   Copyright (C) 2006, 2008, 2010 Craig Edwards <brain@inspircd.org>
  *
  * 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
@@ -24,6 +25,7 @@
 
 
 #include "inspircd.h"
+#include "modules/ctctags.h"
 #include "modules/exemption.h"
 
 /** Holds flood settings and state for mode +f
@@ -35,7 +37,7 @@ class floodsettings
        unsigned int secs;
        unsigned int lines;
        time_t reset;
-       insp::flat_map<User*, unsigned int> counters;
+       insp::flat_map<User*, double> counters;
 
        floodsettings(bool a, unsigned int b, unsigned int c)
                : ban(a)
@@ -45,7 +47,7 @@ class floodsettings
                reset = ServerInstance->Time() + secs;
        }
 
-       bool addmessage(User* who)
+       bool addmessage(User* who, double weight)
        {
                if (ServerInstance->Time() > reset)
                {
@@ -53,7 +55,8 @@ class floodsettings
                        reset = ServerInstance->Time() + secs;
                }
 
-               return (++counters[who] >= this->lines);
+               counters[who] += weight;
+               return (counters[who] >= this->lines);
        }
 
        void clear(User* who)
@@ -70,6 +73,7 @@ class MsgFlood : public ParamMode<MsgFlood, SimpleExtItem<floodsettings> >
        MsgFlood(Module* Creator)
                : ParamMode<MsgFlood, SimpleExtItem<floodsettings> >(Creator, "flood", 'f')
        {
+               syntax = "[*]<messages>:<seconds>";
        }
 
        ModeAction OnSet(User* source, Channel* channel, std::string& parameter) CXX11_OVERRIDE
@@ -77,18 +81,18 @@ class MsgFlood : public ParamMode<MsgFlood, SimpleExtItem<floodsettings> >
                std::string::size_type colon = parameter.find(':');
                if ((colon == std::string::npos) || (parameter.find('-') != std::string::npos))
                {
-                       source->WriteNumeric(608, channel->name, "Invalid flood parameter");
+                       source->WriteNumeric(Numerics::InvalidModeParameter(channel, this, parameter));
                        return MODEACTION_DENY;
                }
 
                /* Set up the flood parameters for this channel */
                bool ban = (parameter[0] == '*');
-               unsigned int nlines = ConvToInt(parameter.substr(ban ? 1 : 0, ban ? colon-1 : colon));
-               unsigned int nsecs = ConvToInt(parameter.substr(colon+1));
+               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))
                {
-                       source->WriteNumeric(608, channel->name, "Invalid flood parameter");
+                       source->WriteNumeric(Numerics::InvalidModeParameter(channel, this, parameter));
                        return MODEACTION_DENY;
                }
 
@@ -105,20 +109,34 @@ class MsgFlood : public ParamMode<MsgFlood, SimpleExtItem<floodsettings> >
        }
 };
 
-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()
-               : exemptionprov(this)
+               : CTCTags::EventListener(this)
+               , exemptionprov(this)
                , mf(this)
        {
        }
 
-       ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details) CXX11_OVERRIDE
+       void ReadConfig(ConfigStatus&) CXX11_OVERRIDE
+       {
+               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;
@@ -134,7 +152,7 @@ class ModuleMsgFlood : public Module
                floodsettings *f = mf.ext.get(dest);
                if (f)
                {
-                       if (f->addmessage(user))
+                       if (f->addmessage(user, weight))
                        {
                                /* Youre outttta here! */
                                f->clear(user);
@@ -157,6 +175,16 @@ class ModuleMsgFlood : public Module
                return MOD_RES_PASSTHRU;
        }
 
+       ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details) CXX11_OVERRIDE
+       {
+               return HandleMessage(user, target, (details.type == MSG_PRIVMSG ? privmsg : notice));
+       }
+
+       ModResult OnUserPreTagMessage(User* user, const MessageTarget& target, CTCTags::TagMessageDetails& details) CXX11_OVERRIDE
+       {
+               return HandleMessage(user, target, tagmsg);
+       }
+
        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.)
@@ -165,7 +193,7 @@ class ModuleMsgFlood : public Module
 
        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);
        }
 };