Sync helpop chmodes s and p with docs

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

diff --git a/src/modules/m_joinflood.cpp b/src/modules/m_joinflood.cpp
index 56131f0be3339a4022ff5a819f41ac22adb75b67..3241020bfb32aa358b1580c4c749176918c09769 100644 (file)
--- a/src/modules/m_joinflood.cpp
+++ b/src/modules/m_joinflood.cpp
@@ -1,11 +1,13 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
+ *   Copyright (C) 2013, 2016-2020 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012-2014 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 Robin Burchell <robin+git@viroteck.net>
  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
- *   Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
- *   Copyright (C) 2006-2007 Craig Edwards <craigedwards@brainbox.cc>
- *   Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
+ *   Copyright (C) 2006-2007, 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
@@ -22,6 +24,16 @@
 
 
 #include "inspircd.h"
+#include "modules/server.h"
+
+enum
+{
+       // From RFC 2182.
+       ERR_UNAVAILRESOURCE = 437
+};
+
+// The number of seconds the channel will be closed for.
+static unsigned int duration;
 
 /** Holds settings and state associated with channel mode +j
  */
@@ -71,7 +83,7 @@ class joinfloodsettings
 
        void lock()
        {
-               unlocktime = ServerInstance->Time() + 60;
+               unlocktime = ServerInstance->Time() + duration;
        }
 
        bool operator==(const joinfloodsettings& other) const
@@ -88,23 +100,24 @@ class JoinFlood : public ParamMode<JoinFlood, SimpleExtItem<joinfloodsettings> >
        JoinFlood(Module* Creator)
                : ParamMode<JoinFlood, SimpleExtItem<joinfloodsettings> >(Creator, "joinflood", 'j')
        {
+               syntax = "<joins>:<seconds>";
        }
 
-       ModeAction OnSet(User* source, Channel* channel, std::string& parameter)
+       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))
                {
-                       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 */
-               unsigned int njoins = ConvToInt(parameter.substr(0, colon));
-               unsigned int nsecs = ConvToInt(parameter.substr(colon+1));
+               unsigned int njoins = ConvToNum<unsigned int>(parameter.substr(0, colon));
+               unsigned int nsecs = ConvToNum<unsigned int>(parameter.substr(colon+1));
                if ((njoins<1) || (nsecs<1))
                {
-                       source->WriteNumeric(608, channel->name, "Invalid flood parameter");
+                       source->WriteNumeric(Numerics::InvalidModeParameter(channel, this, parameter));
                        return MODEACTION_DENY;
                }
 
@@ -119,14 +132,41 @@ class JoinFlood : public ParamMode<JoinFlood, SimpleExtItem<joinfloodsettings> >
        }
 };
 
-class ModuleJoinFlood : public Module
+class ModuleJoinFlood
+       : public Module
+       , public ServerProtocol::LinkEventListener
 {
+ private:
        JoinFlood jf;
+       time_t ignoreuntil;
+       unsigned long bootwait;
+       unsigned long splitwait;
 
  public:
+       // Stop GCC warnings about the deprecated OnServerSplit event.
+       using ServerProtocol::LinkEventListener::OnServerSplit;
+
        ModuleJoinFlood()
-               : jf(this)
+               : ServerProtocol::LinkEventListener(this)
+               , jf(this)
+               , ignoreuntil(0)
+       {
+       }
+
+       void ReadConfig(ConfigStatus&) CXX11_OVERRIDE
+       {
+               ConfigTag* tag = ServerInstance->Config->ConfValue("joinflood");
+               duration = tag->getDuration("duration", 60, 10, 600);
+               bootwait = tag->getDuration("bootwait", 30);
+               splitwait = tag->getDuration("splitwait", 30);
+
+               ignoreuntil = ServerInstance->startup_time + bootwait;
+       }
+
+       void OnServerSplit(const Server* server, bool error) CXX11_OVERRIDE
        {
+               if (splitwait)
+                       ignoreuntil = ServerInstance->Time() + splitwait;
        }
 
        ModResult OnUserPreJoin(LocalUser* user, Channel* chan, const std::string& cname, std::string& privs, const std::string& keygiven) CXX11_OVERRIDE
@@ -136,7 +176,7 @@ class ModuleJoinFlood : public Module
                        joinfloodsettings *f = jf.ext.get(chan);
                        if (f && f->islocked())
                        {
-                               user->WriteNumeric(609, chan->name, "This channel is temporarily unavailable (+j). Please try again later.");
+                               user->WriteNumeric(ERR_UNAVAILRESOURCE, chan->name, "This channel is temporarily unavailable (+j is set). Please try again later.");
                                return MOD_RES_DENY;
                        }
                }
@@ -146,7 +186,7 @@ class ModuleJoinFlood : public Module
        void OnUserJoin(Membership* memb, bool sync, bool created, CUList& excepts) CXX11_OVERRIDE
        {
                /* We arent interested in JOIN events caused by a network burst */
-               if (sync)
+               if (sync || ignoreuntil > ServerInstance->Time())
                        return;
 
                joinfloodsettings *f = jf.ext.get(memb->chan);
@@ -159,14 +199,14 @@ class ModuleJoinFlood : public Module
                        {
                                f->clear();
                                f->lock();
-                               memb->chan->WriteNotice(InspIRCd::Format("This channel has been closed to new users for 60 seconds because there have been more than %d joins in %d seconds.", f->joins, f->secs));
+                               memb->chan->WriteNotice(InspIRCd::Format("This channel has been closed to new users for %u seconds because there have been more than %d joins in %d seconds.", duration, f->joins, f->secs));
                        }
                }
        }
 
        Version GetVersion() CXX11_OVERRIDE
        {
-               return Version("Provides channel mode +j (join flood protection)", VF_VENDOR);
+               return Version("Adds channel mode j (joinflood) which helps protect against spammers which mass-join channels.", VF_VENDOR);
        }
 };