]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_joinflood.cpp
Sync helpop chmodes s and p with docs
[user/henk/code/inspircd.git] / src / modules / m_joinflood.cpp
index 40a007c2c8da0c2790c94e001a5f7f1a67896004..3241020bfb32aa358b1580c4c749176918c09769 100644 (file)
@@ -1,51 +1,66 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *   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) 2006-2007, 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"
+#include "modules/server.h"
+
+enum
+{
+       // From RFC 2182.
+       ERR_UNAVAILRESOURCE = 437
+};
 
-/* $ModDesc: Provides channel mode +j (join flood protection) */
+// The number of seconds the channel will be closed for.
+static unsigned int duration;
 
 /** Holds settings and state associated with channel mode +j
  */
-class joinfloodsettings : public classbase
+class joinfloodsettings
 {
  public:
-
-       int secs;
-       int joins;
+       unsigned int secs;
+       unsigned int joins;
        time_t reset;
        time_t unlocktime;
-       int counter;
-       bool locked;
-       InspIRCd* ServerInstance;
+       unsigned int counter;
 
-       joinfloodsettings() : secs(0), joins(0) {};
-
-       joinfloodsettings(int b, int c) : secs(b), joins(c)
+       joinfloodsettings(unsigned int b, unsigned int c)
+               : secs(b), joins(c), unlocktime(0), counter(0)
        {
                reset = ServerInstance->Time() + secs;
-               counter = 0;
-               locked = false;
-       };
+       }
 
        void addjoin()
        {
-               counter++;
                if (ServerInstance->Time() > reset)
                {
-                       counter = 0;
+                       counter = 1;
                        reset = ServerInstance->Time() + secs;
                }
+               else
+                       counter++;
        }
 
        bool shouldlock()
@@ -60,226 +75,138 @@ class joinfloodsettings : public classbase
 
        bool islocked()
        {
-               if (locked)
-               {
-                       if (ServerInstance->Time() > unlocktime)
-                       {
-                               locked = false;
-                               return false;
-                       }
-                       else
-                       {
-                               return true;
-                       }
-               }
-               return false;
+               if (ServerInstance->Time() > unlocktime)
+                       unlocktime = 0;
+
+               return (unlocktime != 0);
        }
 
        void lock()
        {
-               locked = true;
-               unlocktime = ServerInstance->Time() + 60;
+               unlocktime = ServerInstance->Time() + duration;
        }
 
+       bool operator==(const joinfloodsettings& other) const
+       {
+               return ((this->secs == other.secs) && (this->joins == other.joins));
+       }
 };
 
 /** Handles channel mode +j
  */
-class JoinFlood : public ModeHandler
+class JoinFlood : public ParamMode<JoinFlood, SimpleExtItem<joinfloodsettings> >
 {
  public:
-       JoinFlood(InspIRCd* Instance) : ModeHandler(Instance, 'j', 1, 0, false, MODETYPE_CHANNEL, false) { }
-
-       ModePair ModeSet(User* source, User* dest, Channel* channel, const std::string &parameter)
-       {
-               joinfloodsettings* x;
-               if (channel->GetExt("joinflood",x))
-                       return std::make_pair(true, ConvToStr(x->joins)+":"+ConvToStr(x->secs));
-               else
-                       return std::make_pair(false, parameter);
-       }
-
-       bool CheckTimeStamp(time_t theirs, time_t ours, const std::string &their_param, const std::string &our_param, Channel* channel)
+       JoinFlood(Module* Creator)
+               : ParamMode<JoinFlood, SimpleExtItem<joinfloodsettings> >(Creator, "joinflood", 'j')
        {
-               /* When TS is equal, the alphabetically later one wins */
-               return (their_param < our_param);
+               syntax = "<joins>:<seconds>";
        }
 
-       ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, bool)
+       ModeAction OnSet(User* source, Channel* channel, std::string& parameter) CXX11_OVERRIDE
        {
-               joinfloodsettings* dummy;
-
-               if (adding)
+               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* joins = data;
-                       char* secs = NULL;
-                       while (*data)
-                       {
-                               if (*data == ':')
-                               {
-                                       *data = 0;
-                                       data++;
-                                       secs = data;
-                                       break;
-                               }
-                               else data++;
-                       }
-                       if (secs)
-
-                       {
-                               /* Set up the flood parameters for this channel */
-                               int njoins = atoi(joins);
-                               int nsecs = atoi(secs);
-                               if ((njoins<1) || (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 (!channel->GetExt("joinflood", dummy))
-                                       {
-                                               parameter = ConvToStr(njoins) + ":" +ConvToStr(nsecs);
-                                               joinfloodsettings *f = new joinfloodsettings(nsecs,njoins);
-                                               channel->Extend("joinflood", f);
-                                               channel->SetMode('j', true);
-                                               channel->SetModeParam('j', parameter.c_str(), true);
-                                               return MODEACTION_ALLOW;
-                                       }
-                                       else
-                                       {
-                                               std::string cur_param = channel->GetModeParameter('j');
-                                               parameter = ConvToStr(njoins) + ":" +ConvToStr(nsecs);
-                                               if (cur_param == parameter)
-                                               {
-                                                       // mode params match
-                                                       return MODEACTION_DENY;
-                                               }
-                                               else
-                                               {
-                                                       // new mode param, replace old with new
-                                                       if ((nsecs > 0) && (njoins > 0))
-                                                       {
-                                                               joinfloodsettings* f;
-                                                               channel->GetExt("joinflood", f);
-                                                               delete f;
-                                                               f = new joinfloodsettings(nsecs,njoins);
-                                                               channel->Shrink("joinflood");
-                                                               channel->Extend("joinflood", f);
-                                                               channel->SetModeParam('j', cur_param.c_str(), false);
-                                                               channel->SetModeParam('j', parameter.c_str(), true);
-                                                               return MODEACTION_ALLOW;
-                                                       }
-                                                       else
-                                                       {
-                                                               return MODEACTION_DENY;
-                                                       }
-                                               }
-                                       }
-                               }
-                       }
-                       else
-                       {
-                               source->WriteNumeric(608, "%s %s :Invalid flood parameter",source->nick.c_str(),channel->name.c_str());
-                               return MODEACTION_DENY;
-                       }
+                       source->WriteNumeric(Numerics::InvalidModeParameter(channel, this, parameter));
+                       return MODEACTION_DENY;
                }
-               else
+
+               /* Set up the flood parameters for this channel */
+               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))
                {
-                       if (channel->GetExt("joinflood", dummy))
-                       {
-                               joinfloodsettings *f;
-                               channel->GetExt("joinflood", f);
-                               delete f;
-                               channel->Shrink("joinflood");
-                               channel->SetMode('j', false);
-                               return MODEACTION_ALLOW;
-                       }
+                       source->WriteNumeric(Numerics::InvalidModeParameter(channel, this, parameter));
+                       return MODEACTION_DENY;
                }
-               return MODEACTION_DENY;
+
+               ext.set(channel, new joinfloodsettings(nsecs, njoins));
+               return MODEACTION_ALLOW;
+       }
+
+       void SerializeParam(Channel* chan, const joinfloodsettings* jfs, std::string& out)
+       {
+               out.append(ConvToStr(jfs->joins)).push_back(':');
+               out.append(ConvToStr(jfs->secs));
        }
 };
 
-class ModuleJoinFlood : public Module
+class ModuleJoinFlood
+       : public Module
+       , public ServerProtocol::LinkEventListener
 {
-
-       JoinFlood* jf;
+ 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()
+               : ServerProtocol::LinkEventListener(this)
+               , jf(this)
+               , ignoreuntil(0)
+       {
+       }
 
-       ModuleJoinFlood(InspIRCd* Me)
-               : Module(Me)
+       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);
 
-               jf = new JoinFlood(ServerInstance);
-               if (!ServerInstance->Modes->AddMode(jf))
-                       throw ModuleException("Could not add new modes!");
-               Implementation eventlist[] = { I_OnChannelDelete, I_OnUserPreJoin, I_OnUserJoin };
-               ServerInstance->Modules->Attach(eventlist, this, 3);
+               ignoreuntil = ServerInstance->startup_time + bootwait;
        }
 
-       virtual int OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven)
+       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
        {
                if (chan)
                {
-                       joinfloodsettings *f;
-                       if (chan->GetExt("joinflood", f))
+                       joinfloodsettings *f = jf.ext.get(chan);
+                       if (f && f->islocked())
                        {
-                               if (f->islocked())
-                               {
-                                       user->WriteNumeric(609, "%s %s :This channel is temporarily unavailable (+j). Please try again later.",user->nick.c_str(),chan->name.c_str());
-                                       return 1;
-                               }
+                               user->WriteNumeric(ERR_UNAVAILRESOURCE, chan->name, "This channel is temporarily unavailable (+j is set). Please try again later.");
+                               return MOD_RES_DENY;
                        }
                }
-               return 0;
+               return MOD_RES_PASSTHRU;
        }
 
-       virtual void OnUserJoin(User* user, Channel* channel, bool sync, bool &silent)
+       void OnUserJoin(Membership* memb, bool sync, bool created, CUList& excepts) CXX11_OVERRIDE
        {
-               joinfloodsettings *f;
-
                /* 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);
+
                /* But all others are OK */
-               if (channel->GetExt("joinflood",f))
+               if ((f) && (!f->islocked()))
                {
                        f->addjoin();
                        if (f->shouldlock())
                        {
                                f->clear();
                                f->lock();
-                               channel->WriteChannelWithServ((char*)ServerInstance->Config->ServerName, "NOTICE %s :This channel has been closed to new users for 60 seconds because there have been more than %d joins in %d seconds.", channel->name.c_str(), 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));
                        }
                }
        }
 
-       void OnChannelDelete(Channel* chan)
-       {
-               joinfloodsettings *f;
-               if (chan->GetExt("joinflood",f))
-               {
-                       delete f;
-                       chan->Shrink("joinflood");
-               }
-       }
-
-
-       virtual ~ModuleJoinFlood()
-       {
-               ServerInstance->Modes->DelMode(jf);
-               delete jf;
-       }
-
-       virtual Version GetVersion()
+       Version GetVersion() CXX11_OVERRIDE
        {
-               return Version("$Id$", VF_COMMON | VF_VENDOR, API_VERSION);
+               return Version("Adds channel mode j (joinflood) which helps protect against spammers which mass-join channels.", VF_VENDOR);
        }
 };