]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_botmode.cpp
Add support for blocking tag messages with the deaf mode.
[user/henk/code/inspircd.git] / src / modules / m_botmode.cpp
index b5ae6b32a22a5f520a4602649e787504714b7bcc..a31d51d3d9a2c740b20cbf5c3fbab47bd4a54769 100644 (file)
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- *                       E-mail:
- *                <brain@chatspike.net>
- *               <Craig@chatspike.net>
- *     
- * Written by Craig Edwards, Craig McLure, and others.
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ *   Copyright (C) 2013, 2017-2020 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012, 2015 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2012 Shawn Smith <ShawnSmith0828@gmail.com>
+ *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2004, 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
+ * 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/>.
  */
 
-using namespace std;
 
-#include <stdio.h>
-#include <string>
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
-#include "configreader.h"
 #include "inspircd.h"
+#include "modules/ctctags.h"
+#include "modules/who.h"
+#include "modules/whois.h"
 
-/* $ModDesc: Provides support for unreal-style umode +B */
+enum
+{
+       // From UnrealIRCd.
+       RPL_WHOISBOT = 335
+};
 
-/** Handles user mode +B
- */
-class BotMode : public ModeHandler
+class BotTag : public ClientProtocol::MessageTagProvider
 {
+ private:
+       SimpleUserModeHandler& botmode;
+       CTCTags::CapReference ctctagcap;
+
  public:
-       BotMode(InspIRCd* Instance) : ModeHandler(Instance, 'B', 0, 0, false, MODETYPE_USER, false) { }
+       BotTag(Module* mod, SimpleUserModeHandler& bm)
+               : ClientProtocol::MessageTagProvider(mod)
+               , botmode(bm)
+               , ctctagcap(mod)
+       {
+       }
 
-       ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string &parameter, bool adding)
+       void OnPopulateTags(ClientProtocol::Message& msg) CXX11_OVERRIDE
        {
-               /* Only opers can change other users modes */
-               if ((source != dest) && (!*source->oper))
-                       return MODEACTION_DENY;
+               User* const user = msg.GetSourceUser();
+               if (user && user->IsModeSet(botmode))
+                       msg.AddTag("inspircd.org/bot", this, "");
+       }
 
-               if (adding)
-               {
-                       if (!dest->IsModeSet('B'))
-                       {
-                               dest->SetMode('B',true);
-                               return MODEACTION_ALLOW;
-                       }
-               }
-               else
-               {
-                       if (dest->IsModeSet('B'))
-                       {
-                               dest->SetMode('B',false);
-                               return MODEACTION_ALLOW;
-                       }
-               }
-               
-               return MODEACTION_DENY;
+       bool ShouldSendTag(LocalUser* user, const ClientProtocol::MessageTagData& tagdata) CXX11_OVERRIDE
+       {
+               return ctctagcap.get(user);
        }
 };
 
-class ModuleBotMode : public Module
+class ModuleBotMode
+       : public Module
+       , public Who::EventListener
+       , public Whois::EventListener
 {
-       
-       BotMode* bm;
+ private:
+       SimpleUserModeHandler bm;
+       BotTag tag;
+       bool forcenotice;
+
  public:
-       ModuleBotMode(InspIRCd* Me)
-               : Module::Module(Me)
+       ModuleBotMode()
+               : Who::EventListener(this)
+               , Whois::EventListener(this)
+               , bm(this, "bot", 'B')
+               , tag(this, bm)
        {
-               
-               bm = new BotMode(ServerInstance);
-               ServerInstance->AddMode(bm, 'B');
        }
 
-       void Implements(char* List)
-       {
-               List[I_OnWhois] = 1;
-       }
-       
-       virtual ~ModuleBotMode()
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
        {
-               ServerInstance->Modes->DelMode(bm);
-               DELETE(bm);
+               forcenotice = ServerInstance->Config->ConfValue("botmode")->getBool("forcenotice");
        }
-       
-       virtual Version GetVersion()
+
+       void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE
        {
-               return Version(1,1,0,0,VF_COMMON|VF_VENDOR,API_VERSION);
+               tokens["BOT"] = ConvToStr(bm.GetModeChar());
        }
 
-       virtual void OnWhois(userrec* src, userrec* dst)
+       ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details) CXX11_OVERRIDE
        {
-               if (dst->IsModeSet('B'))
-               {
-                       ServerInstance->SendWhoisLine(src, dst, 335, std::string(src->nick)+" "+std::string(dst->nick)+" :is a \2bot\2 on "+ServerInstance->Config->Network);
-               }
-       }
+               // Allow sending if forcenotice is off, the user is not a bot, or if the message is a notice.
+               if (!forcenotice || !user->IsModeSet(bm) || details.type == MSG_NOTICE)
+                       return MOD_RES_PASSTHRU;
 
-};
+               // Allow sending PRIVMSGs to services pseudoclients.
+               if (target.type == MessageTarget::TYPE_USER && target.Get<User>()->server->IsULine())
+                       return MOD_RES_PASSTHRU;
 
-// stuff down here is the module-factory stuff. For basic modules you can ignore this.
+               // Force the message to be broadcast as a NOTICE.
+               details.type = MSG_NOTICE;
+               return MOD_RES_PASSTHRU;
+       }
 
-class ModuleBotModeFactory : public ModuleFactory
-{
- public:
-       ModuleBotModeFactory()
+       ModResult OnWhoLine(const Who::Request& request, LocalUser* source, User* user, Membership* memb, Numeric::Numeric& numeric) CXX11_OVERRIDE
        {
+               size_t flag_index;
+               if (!request.GetFieldIndex('f', flag_index))
+                       return MOD_RES_PASSTHRU;
+
+               if (user->IsModeSet(bm))
+                       numeric.GetParams()[flag_index].push_back('B');
+
+               return MOD_RES_PASSTHRU;
        }
-       
-       ~ModuleBotModeFactory()
+
+       Version GetVersion() CXX11_OVERRIDE
        {
+               return Version("Adds user mode B (bot) which marks users with it set as bots in their /WHOIS response.",VF_VENDOR);
        }
-       
-       virtual Module * CreateModule(InspIRCd* Me)
+
+       void OnWhois(Whois::Context& whois) CXX11_OVERRIDE
        {
-               return new ModuleBotMode(Me);
+               if (whois.GetTarget()->IsModeSet(bm))
+               {
+                       whois.SendLine(RPL_WHOISBOT, "is a bot on " + ServerInstance->Config->Network);
+               }
        }
-       
 };
 
-
-extern "C" void * init_module( void )
-{
-       return new ModuleBotModeFactory;
-}
+MODULE_INIT(ModuleBotMode)