]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_delaymsg.cpp
Sync helpop chmodes s and p with docs
[user/henk/code/inspircd.git] / src / modules / m_delaymsg.cpp
index 5e2bb838cce057f7d5032a9e86c25877b121195a..27e2c3e4011ca6c65870763b1c888c353f2580fa 100644 (file)
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ *   Copyright (C) 2013, 2017-2020 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012-2015 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@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 <stdarg.h>
 
-/* $ModDesc: Provides channelmode +d <int>, to deny messages to a channel until <int> seconds. */
+#include "inspircd.h"
+#include "modules/ctctags.h"
 
-class DelayMsgMode : public ModeHandler
+class DelayMsgMode : public ParamMode<DelayMsgMode, LocalIntExt>
 {
- private:
-       CUList empty;
  public:
        LocalIntExt jointime;
-       DelayMsgMode(InspIRCd* Instance, Module* Parent) : ModeHandler(Instance, Parent, 'd', 1, 0, false, MODETYPE_CHANNEL, false, 0, '@'), jointime("delaymsg", Parent) {};
-
-       ModePair ModeSet(User*, User*, Channel* channel, const std::string &parameter)
+       DelayMsgMode(Module* Parent)
+               : ParamMode<DelayMsgMode, LocalIntExt>(Parent, "delaymsg", 'd')
+               , jointime("delaymsg", ExtensionItem::EXT_MEMBERSHIP, Parent)
        {
-               std::string climit = channel->GetModeParameter('d');
-               if (!climit.empty())
-               {
-                       return std::make_pair(true, climit);
-               }
-               else
-               {
-                       return std::make_pair(false, parameter);
-               }
+               ranktoset = ranktounset = OP_VALUE;
+               syntax = "<seconds>";
        }
 
-       bool CheckTimeStamp(std::string &their_param, const std::string &our_param, Channel*)
+       bool ResolveModeConflict(std::string& their_param, const std::string& our_param, Channel*) CXX11_OVERRIDE
        {
-               return (atoi(their_param.c_str()) < atoi(our_param.c_str()));
+               return ConvToNum<intptr_t>(their_param) < ConvToNum<intptr_t>(our_param);
        }
 
-       ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding);
+       ModeAction OnSet(User* source, Channel* chan, std::string& parameter) CXX11_OVERRIDE;
+       void OnUnset(User* source, Channel* chan) CXX11_OVERRIDE;
+
+       void SerializeParam(Channel* chan, intptr_t n, std::string& out)
+       {
+               out += ConvToStr(n);
+       }
 };
 
-class ModuleDelayMsg : public Module
+class ModuleDelayMsg
+       : public Module
+       , public CTCTags::EventListener
 {
  private:
        DelayMsgMode djm;
+       bool allownotice;
+       ModResult HandleMessage(User* user, const MessageTarget& target, bool notice);
+
  public:
-       ModuleDelayMsg(InspIRCd* Me) : Module(Me), djm(Me, this)
+       ModuleDelayMsg()
+               : CTCTags::EventListener(this)
+               , djm(this)
        {
-               if (!ServerInstance->Modes->AddMode(&djm))
-                       throw ModuleException("Could not add new modes!");
-               Extensible::Register(&djm.jointime);
-               Implementation eventlist[] = { I_OnUserJoin, I_OnUserPreMessage};
-               ServerInstance->Modules->Attach(eventlist, this, 2);
        }
-       ~ModuleDelayMsg();
-       Version GetVersion();
-       void OnUserJoin(User* user, Channel* channel, bool sync, bool &silent, bool created);
-       void OnUserPart(User* user, Channel* channel, std::string &partmessage, bool &silent);
-       void OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent);
-       void OnCleanup(int target_type, void* item);
-       ModResult OnUserPreMessage(User* user, void* dest, int target_type, std::string &text, char status, CUList &exempt_list);
+
+       Version GetVersion() CXX11_OVERRIDE;
+       void OnUserJoin(Membership* memb, bool sync, bool created, CUList&) CXX11_OVERRIDE;
+       ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details) CXX11_OVERRIDE;
+       ModResult OnUserPreTagMessage(User* user, const MessageTarget& target, CTCTags::TagMessageDetails& details) CXX11_OVERRIDE;
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE;
 };
 
-ModeAction DelayMsgMode::OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding)
+ModeAction DelayMsgMode::OnSet(User* source, Channel* chan, std::string& parameter)
 {
-       if (adding)
-       {
-               /* Setting a new limit, sanity check */
-               long limit = atoi(parameter.c_str());
-
-               /* Wrap low values at 32768 */
-               if (limit < 0)
-                       limit = 0x7FFF;
+       // Setting a new limit, sanity check
+       intptr_t limit = ConvToNum<intptr_t>(parameter);
+       if (limit <= 0)
+               limit = 1;
 
-               parameter = ConvToStr(limit);
-       }
-       else
-       {
-               /*
-                * Clean up metadata
-                */
-               const UserMembList* names = channel->GetUsers();
-               for (UserMembCIter n = names->begin(); n != names->end(); ++n)
-                       jointime.set(n->second, 0);
-       }
-       channel->SetModeParam('d', adding ? parameter : "");
+       ext.set(chan, limit);
        return MODEACTION_ALLOW;
 }
 
-ModuleDelayMsg::~ModuleDelayMsg()
+void DelayMsgMode::OnUnset(User* source, Channel* chan)
 {
-       ServerInstance->Modes->DelMode(&djm);
+       /*
+        * Clean up metadata
+        */
+       const Channel::MemberMap& users = chan->GetUsers();
+       for (Channel::MemberMap::const_iterator n = users.begin(); n != users.end(); ++n)
+               jointime.set(n->second, 0);
 }
 
 Version ModuleDelayMsg::GetVersion()
 {
-       return Version("$Id$", VF_COMMON | VF_VENDOR, API_VERSION);
+       return Version("Adds channel mode d (delaymsg) which prevents newly joined users from speaking until the specified number of seconds have passed.", VF_VENDOR);
 }
 
-void ModuleDelayMsg::OnUserJoin(User* user, Channel* channel, bool sync, bool &silent, bool created)
+void ModuleDelayMsg::OnUserJoin(Membership* memb, bool sync, bool created, CUList&)
 {
-       if (channel->IsModeSet('d'))
+       if ((IS_LOCAL(memb->user)) && (memb->chan->IsModeSet(djm)))
        {
-               Membership* memb = channel->GetUser(user);
                djm.jointime.set(memb, ServerInstance->Time());
        }
 }
 
-ModResult ModuleDelayMsg::OnUserPreMessage(User* user, void* dest, int target_type, std::string &text, char status, CUList &exempt_list)
+ModResult ModuleDelayMsg::OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details)
 {
-       /* Server origin */
-       if (!user)
+       return HandleMessage(user, target, details.type == MSG_NOTICE);
+}
+
+ModResult ModuleDelayMsg::OnUserPreTagMessage(User* user, const MessageTarget& target, CTCTags::TagMessageDetails& details)
+{
+       return HandleMessage(user, target, false);
+}
+
+ModResult ModuleDelayMsg::HandleMessage(User* user, const MessageTarget& target, bool notice)
+{
+       if (!IS_LOCAL(user))
                return MOD_RES_PASSTHRU;
 
-       if (target_type != TYPE_CHANNEL)
+       if ((target.type != MessageTarget::TYPE_CHANNEL) || ((!allownotice) && (notice)))
                return MOD_RES_PASSTHRU;
 
-       Channel* channel = (Channel*) dest;
+       Channel* channel = target.Get<Channel>();
        Membership* memb = channel->GetUser(user);
 
        if (!memb)
                return MOD_RES_PASSTHRU;
-       
+
        time_t ts = djm.jointime.get(memb);
 
        if (ts == 0)
                return MOD_RES_PASSTHRU;
 
-       std::string len = channel->GetModeParameter('d');
+       int len = djm.ext.get(channel);
 
-       if (ts + atoi(len.c_str()) > ServerInstance->Time())
+       if ((ts + len) > ServerInstance->Time())
        {
                if (channel->GetPrefixValue(user) < VOICE_VALUE)
                {
-                       user->WriteNumeric(404, "%s %s :You must wait %s seconds after joining to send to channel (+d)",
-                               user->nick.c_str(), channel->name.c_str(), len.c_str());
+                       const std::string message = InspIRCd::Format("You cannot send messages to this channel until you have been a member for %d seconds.", len);
+                       user->WriteNumeric(Numerics::CannotSendTo(channel, message));
                        return MOD_RES_DENY;
                }
        }
@@ -151,5 +154,10 @@ ModResult ModuleDelayMsg::OnUserPreMessage(User* user, void* dest, int target_ty
        return MOD_RES_PASSTHRU;
 }
 
-MODULE_INIT(ModuleDelayMsg)
+void ModuleDelayMsg::ReadConfig(ConfigStatus& status)
+{
+       ConfigTag* tag = ServerInstance->Config->ConfValue("delaymsg");
+       allownotice = tag->getBool("allownotice", true);
+}
 
+MODULE_INIT(ModuleDelayMsg)