]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_blockcaps.cpp
Update copyright headers.
[user/henk/code/inspircd.git] / src / modules / m_blockcaps.cpp
index 076f625cebe873613f18e926e53857c8a5edc089..02b95e150a63ac97773eb2e9bbc8e2cdd194c2e8 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-2018, 2020-2021 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012-2014 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2006, 2008-2009 Craig Edwards <brain@inspircd.org>
+ *   Copyright (C) 2006 Oliver Lupton <om@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"
-
-/* $ModDesc: Provides support to block all-CAPS channel messages and notices */
-
 
-/** Handles the +B channel mode
- */
-class BlockCaps : public SimpleChannelModeHandler
-{
- public:
-       BlockCaps(Module* Creator) : SimpleChannelModeHandler(Creator, "blockcaps", 'B') { }
-};
+#include "inspircd.h"
+#include "modules/exemption.h"
 
 class ModuleBlockCAPS : public Module
 {
-       BlockCaps bc;
-       int percent;
+       CheckExemption::EventProvider exemptionprov;
+       SimpleChannelModeHandler bc;
+       unsigned int percent;
        unsigned int minlen;
-       char capsmap[256];
-public:
+       std::bitset<UCHAR_MAX + 1> lowercase;
+       std::bitset<UCHAR_MAX + 1> uppercase;
 
-       ModuleBlockCAPS() : bc(this)
-       {
-               OnRehash(NULL);
-               if (!ServerInstance->Modes->AddMode(&bc))
-                       throw ModuleException("Could not add new modes!");
-               Implementation eventlist[] = { I_OnUserPreMessage, I_OnUserPreNotice, I_OnRehash, I_On005Numeric };
-               ServerInstance->Modules->Attach(eventlist, this, 4);
-       }
-
-       virtual void On005Numeric(std::string &output)
+public:
+       ModuleBlockCAPS()
+               : exemptionprov(this)
+               , bc(this, "blockcaps", 'B')
        {
-               ServerInstance->AddExtBanChar('B');
        }
 
-       virtual void OnRehash(User* user)
+       void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE
        {
-               ReadConf();
+               tokens["EXTBAN"].push_back('B');
        }
 
-       virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
+       ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details) CXX11_OVERRIDE
        {
-               if (target_type == TYPE_CHANNEL)
+               if (target.type == MessageTarget::TYPE_CHANNEL)
                {
-                       if ((!IS_LOCAL(user)) || (text.length() < minlen))
+                       if (!IS_LOCAL(user))
                                return MOD_RES_PASSTHRU;
 
-                       Channel* c = (Channel*)dest;
-                       ModResult res;
-                       FIRST_MOD_RESULT(OnChannelRestrictionApply, res, (user,c,"blockcaps"));
+                       Channel* c = target.Get<Channel>();
+                       ModResult res = CheckExemption::Call(exemptionprov, user, c, "blockcaps");
 
                        if (res == MOD_RES_ALLOW)
                                return MOD_RES_PASSTHRU;
 
-                       if (!c->GetExtBanStatus(user, 'B').check(!c->IsModeSet('B')))
+                       if (!c->GetExtBanStatus(user, 'B').check(!c->IsModeSet(bc)))
                        {
-                               int caps = 0;
-                               const char* actstr = "\1ACTION ";
-                               int act = 0;
+                               // If the message is a CTCP then we skip it unless it is
+                               // an ACTION in which case we just check against the body.
+                               std::string ctcpname;
+                               std::string message(details.text);
+                               if (details.IsCTCP(ctcpname, message))
+                               {
+                                       // If the CTCP is not an action then skip it.
+                                       if (!irc::equals(ctcpname, "ACTION"))
+                                               return MOD_RES_PASSTHRU;
+                               }
+
+                               // If the message is shorter than the minimum length
+                               // then we don't need to do anything else.
+                               size_t length = message.length();
+                               if (length < minlen)
+                                       return MOD_RES_PASSTHRU;
 
-                               for (std::string::iterator i = text.begin(); i != text.end(); i++)
+                               // Count the characters to see how many upper case and
+                               // ignored (non upper or lower) characters there are.
+                               size_t upper = 0;
+                               for (std::string::const_iterator iter = message.begin(); iter != message.end(); ++iter)
                                {
-                                       /* Smart fix for suggestion from Jobe, ignore CTCP ACTION (part of /ME) */
-                                       if (*actstr && *i == *actstr++ && act != -1)
-                                       {
-                                               act++;
-                                               continue;
-                                       }
-                                       else
-                                               act = -1;
-
-                                       caps += capsmap[(unsigned char)*i];
+                                       unsigned char chr = static_cast<unsigned char>(*iter);
+                                       if (uppercase.test(chr))
+                                               upper += 1;
+                                       else if (!lowercase.test(chr))
+                                               length -= 1;
                                }
-                               if ( ((caps*100)/(int)text.length()) >= percent )
+
+                               // Calculate the percentage which is upper case. If the
+                               // message was entirely symbols then it can't contain
+                               // any upper case letters.
+                               if (length > 0 && round((upper * 100) / length) >= percent)
                                {
-                                       user->WriteNumeric(ERR_CANNOTSENDTOCHAN, "%s %s :Your message cannot contain more than %d%% capital letters if it's longer than %d characters", user->nick.c_str(), c->name.c_str(), percent, minlen);
+                                       const std::string msg = InspIRCd::Format("Your message cannot contain %d%% or more capital letters if it's longer than %d characters", percent, minlen);
+                                       user->WriteNumeric(Numerics::CannotSendTo(c, msg));
                                        return MOD_RES_DENY;
                                }
                        }
@@ -94,41 +107,26 @@ public:
                return MOD_RES_PASSTHRU;
        }
 
-       virtual ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
-       {
-               return OnUserPreMessage(user,dest,target_type,text,status,exempt_list);
-       }
-
-       void ReadConf()
-       {
-               ConfigReader Conf;
-               percent = Conf.ReadInteger("blockcaps", "percent", "100", 0, true);
-               minlen = Conf.ReadInteger("blockcaps", "minlen", "1", 0, true);
-               std::string hmap = Conf.ReadValue("blockcaps", "capsmap", 0);
-               if (hmap.empty())
-                       hmap = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
-               memset(capsmap, 0, sizeof(capsmap));
-               for (std::string::iterator n = hmap.begin(); n != hmap.end(); n++)
-                       capsmap[(unsigned char)*n] = 1;
-               if (percent < 1 || percent > 100)
-               {
-                       ServerInstance->Logs->Log("CONFIG",DEFAULT, "<blockcaps:percent> out of range, setting to default of 100.");
-                       percent = 100;
-               }
-               if (minlen < 1 || minlen > MAXBUF-1)
-               {
-                       ServerInstance->Logs->Log("CONFIG",DEFAULT, "<blockcaps:minlen> out of range, setting to default of 1.");
-                       minlen = 1;
-               }
-       }
-
-       virtual ~ModuleBlockCAPS()
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
        {
+               ConfigTag* tag = ServerInstance->Config->ConfValue("blockcaps");
+               percent = tag->getUInt("percent", 100, 1, 100);
+               minlen = tag->getUInt("minlen", 1, 1, ServerInstance->Config->Limits.MaxLine);
+
+               lowercase.reset();
+               const std::string lower = tag->getString("lowercase", "abcdefghijklmnopqrstuvwxyz");
+               for (std::string::const_iterator iter = lower.begin(); iter != lower.end(); ++iter)
+                       lowercase.set(static_cast<unsigned char>(*iter));
+
+               uppercase.reset();
+               const std::string upper = tag->getString("uppercase", tag->getString("capsmap", "ABCDEFGHIJKLMNOPQRSTUVWXYZ", 1));
+               for (std::string::const_iterator iter = upper.begin(); iter != upper.end(); ++iter)
+                       uppercase.set(static_cast<unsigned char>(*iter));
        }
 
-       virtual Version GetVersion()
+       Version GetVersion() CXX11_OVERRIDE
        {
-               return Version("Provides support to block all-CAPS channel messages and notices", VF_COMMON|VF_VENDOR);
+               return Version("Adds channel mode B (blockcaps) which allows channels to block messages which are excessively capitalised.", VF_VENDOR);
        }
 };