]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_deaf.cpp
Merge extras/m_privdeaf into m_deaf and update documentation.
[user/henk/code/inspircd.git] / src / modules / m_deaf.cpp
index f08a32d1c8dd007d002b1e6c234cebb3ad0a6927..2f7221313679fb09c2f765ade43438dd6667adf6 100644 (file)
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *   Copyright (C) 2006, 2008 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2006-2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2012 satmd <satmd@satmd.dyndns.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 "users.h"
-#include "channels.h"
-#include "modules.h"
 
-/* $ModDesc: Provides support for ircu style usermode +d (deaf to channel messages and channel notices) */
+#include "inspircd.h"
 
-/** User mode +d - filter out channel messages and channel notices
- */
-class User_d : public ModeHandler
+// User mode +d - filter out channel messages and channel notices
+class DeafMode : public ModeHandler
 {
  public:
-       User_d(InspIRCd* Instance) : ModeHandler(Instance, 'd', 0, 0, false, MODETYPE_USER, false) { }
+       DeafMode(Module* Creator) : ModeHandler(Creator, "deaf", 'd', PARAM_NONE, MODETYPE_USER) { }
 
-       ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding)
+       ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string& parameter, bool adding) CXX11_OVERRIDE
        {
+               if (adding == dest->IsModeSet(this))
+                       return MODEACTION_DENY;
+
                if (adding)
-               {
-                       if (!dest->IsModeSet('d'))
-                       {
-                               dest->WriteServ("NOTICE %s :*** You have enabled usermode +d, deaf mode. This mode means you WILL NOT receive any messages from any channels you are in. If you did NOT mean to do this, use /mode %s -d.", dest->nick, dest->nick);
-                               dest->SetMode('d',true);
-                               return MODEACTION_ALLOW;
-                       }
-               }
-               else
-               {
-                       if (dest->IsModeSet('d'))
-                       {
-                               dest->SetMode('d',false);
-                               return MODEACTION_ALLOW;
-                       }
-               }
-               return MODEACTION_DENY;
+                       dest->WriteNotice("*** You have enabled usermode +d, deaf mode. This mode means you WILL NOT receive any messages from any channels you are in. If you did NOT mean to do this, use /mode " + dest->nick + " -d.");
+
+               dest->SetMode(this, adding);
+               return MODEACTION_ALLOW;
        }
 };
 
-class ModuleDeaf : public Module
+// User mode +D - filter out user messages and user notices
+class PrivDeafMode : public ModeHandler
 {
-       User_d* m1;
-
-       std::string deaf_bypasschars;
-       std::string deaf_bypasschars_uline;
-
  public:
-       ModuleDeaf(InspIRCd* Me)
-               : Module(Me)
+       PrivDeafMode(Module* Creator) : ModeHandler(Creator, "privdeaf", 'D', PARAM_NONE, MODETYPE_USER)
        {
-               m1 = new User_d(ServerInstance);
-               if (!ServerInstance->AddMode(m1))
-                       throw ModuleException("Could not add new modes!");
-
-               OnRehash(NULL, "");
-               Implementation eventlist[] = { I_OnUserPreMessage, I_OnUserPreNotice, I_OnRehash, I_OnBuildExemptList };
-               ServerInstance->Modules->Attach(eventlist, this, 4);
+               if (!ServerInstance->Config->ConfValue("deaf")->getBool("enableprivdeaf"))
+                       DisableAutoRegister();
        }
 
-
-       virtual void OnRehash(User* user, const std::string&)
+       ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string& parameter, bool adding) CXX11_OVERRIDE
        {
-               ConfigReader* conf = new ConfigReader(ServerInstance);
-               deaf_bypasschars = conf->ReadValue("deaf", "bypasschars", 0);
-               deaf_bypasschars_uline = conf->ReadValue("deaf", "bypasscharsuline", 0);
-
-               delete conf;
-       }
+               if (adding == dest->IsModeSet(this))
+                       return MODEACTION_DENY;
 
-       virtual int OnUserPreNotice(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
-       {
-               if (target_type == TYPE_CHANNEL)
-               {
-                       Channel* chan = (Channel*)dest;
-                       if (chan)
-                               this->BuildDeafList(MSG_NOTICE, chan, user, status, text, exempt_list);
-               }
+               if (adding)
+                       dest->WriteNotice("*** You have enabled usermode +D, private deaf mode. This mode means you WILL NOT receive any messages and notices from any nicks. If you did NOT mean to do this, use /mode " + dest->nick + " -D.");
 
-               return 0;
+               dest->SetMode(this, adding);
+               return MODEACTION_ALLOW;
        }
+};
 
-       virtual int OnUserPreMessage(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
-       {
-               if (target_type == TYPE_CHANNEL)
-               {
-                       Channel* chan = (Channel*)dest;
-                       if (chan)
-                               this->BuildDeafList(MSG_PRIVMSG, chan, user, status, text, exempt_list);
-               }
+class ModuleDeaf : public Module
+{
+       DeafMode deafmode;
+       PrivDeafMode privdeafmode;
+       std::string deaf_bypasschars;
+       std::string deaf_bypasschars_uline;
+       bool privdeafuline;
 
-               return 0;
+ public:
+       ModuleDeaf()
+               : deafmode(this)
+               , privdeafmode(this)
+       {
        }
 
-       virtual void OnBuildExemptList(MessageType message_type, Channel* chan, User* sender, char status, CUList &exempt_list, const std::string &text)
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
        {
-               BuildDeafList(message_type, chan, sender, status, text, exempt_list);
+               ConfigTag* tag = ServerInstance->Config->ConfValue("deaf");
+               deaf_bypasschars = tag->getString("bypasschars");
+               deaf_bypasschars_uline = tag->getString("bypasscharsuline");
+               privdeafuline = tag->getBool("privdeafuline", true);
        }
 
-       virtual void BuildDeafList(MessageType message_type, Channel* chan, User* sender, char status, const std::string &text, CUList &exempt_list)
+       ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details) CXX11_OVERRIDE
        {
-               CUList *ulist;
-               bool is_a_uline;
-               bool is_bypasschar, is_bypasschar_avail;
-               bool is_bypasschar_uline, is_bypasschar_uline_avail;
-
-               is_bypasschar = is_bypasschar_avail = is_bypasschar_uline = is_bypasschar_uline_avail = 0;
-               if (!deaf_bypasschars.empty())
+               if (target.type == MessageTarget::TYPE_CHANNEL)
                {
-                       is_bypasschar_avail = 1;
-                       if (deaf_bypasschars.find(text[0], 0) != string::npos)
-                               is_bypasschar = 1;
+                       Channel* chan = target.Get<Channel>();
+                       bool is_bypasschar = (deaf_bypasschars.find(details.text[0]) != std::string::npos);
+                       bool is_bypasschar_uline = (deaf_bypasschars_uline.find(details.text[0]) != std::string::npos);
+
+                       // If we have no bypasschars_uline in config, and this is a bypasschar (regular)
+                       // Then it is obviously going to get through +d, no exemption list required
+                       if (deaf_bypasschars_uline.empty() && is_bypasschar)
+                               return MOD_RES_PASSTHRU;
+                       // If it matches both bypasschar and bypasschar_uline, it will get through.
+                       if (is_bypasschar && is_bypasschar_uline)
+                               return MOD_RES_PASSTHRU;
+
+                       const Channel::MemberMap& ulist = chan->GetUsers();
+                       for (Channel::MemberMap::const_iterator i = ulist.begin(); i != ulist.end(); ++i)
+                       {
+                               // not +d
+                               if (!i->first->IsModeSet(deafmode))
+                                       continue;
+
+                               bool is_a_uline = i->first->server->IsULine();
+                               // matched a U-line only bypass
+                               if (is_bypasschar_uline && is_a_uline)
+                                       continue;
+                               // matched a regular bypass
+                               if (is_bypasschar && !is_a_uline)
+                                       continue;
+
+                               // don't deliver message!
+                               details.exemptions.insert(i->first);
+                       }
                }
-               if (!deaf_bypasschars_uline.empty())
+               else if (target.type == MessageTarget::TYPE_USER)
                {
-                       is_bypasschar_uline_avail = 1;
-                       if (deaf_bypasschars_uline.find(text[0], 0) != string::npos)
-                               is_bypasschar_uline = 1;
-               }
-
-               /*
-                * If we have no bypasschars_uline in config, and this is a bypasschar (regular)
-                * Than it is obviously going to get through +d, no build required
-                */
-               if (!is_bypasschar_uline_avail && is_bypasschar)
-                       return;
+                       User* targ = target.Get<User>();
+                       if (!targ->IsModeSet(privdeafmode))
+                               return MOD_RES_PASSTHRU;
 
-               switch (status)
-               {
-                       case '@':
-                               ulist = chan->GetOppedUsers();
-                               break;
-                       case '%':
-                               ulist = chan->GetHalfoppedUsers();
-                               break;
-                       case '+':
-                               ulist = chan->GetVoicedUsers();
-                               break;
-                       default:
-                               ulist = chan->GetUsers();
-                               break;
-               }
+                       if (!privdeafuline && user->server->IsULine())
+                               return MOD_RES_DENY;
 
-               for (CUList::iterator i = ulist->begin(); i != ulist->end(); i++)
-               {
-                       /* not +d ? */
-                       if (!i->first->IsModeSet('d'))
-                               continue; /* deliver message */
-                       /* matched both U-line only and regular bypasses */
-                       if (is_bypasschar && is_bypasschar_uline)
-                               continue; /* deliver message */
-
-                       is_a_uline = ServerInstance->ULine(i->first->server);
-                       /* matched a U-line only bypass */
-                       if (is_bypasschar_uline && is_a_uline)
-                               continue; /* deliver message */
-                       /* matched a regular bypass */
-                       if (is_bypasschar && !is_a_uline)
-                               continue; /* deliver message */
-
-                       /* don't deliver message! */
-                       exempt_list[i->first] = i->first->nick;
+                       if (!user->HasPrivPermission("users/privdeaf-override"))
+                               return MOD_RES_DENY;
                }
-       }
 
-       virtual ~ModuleDeaf()
-       {
-               ServerInstance->Modes->DelMode(m1);
-               delete m1;
+               return MOD_RES_PASSTHRU;
        }
 
-       virtual Version GetVersion()
+       Version GetVersion() CXX11_OVERRIDE
        {
-               return Version(1,1,0,0,VF_COMMON|VF_VENDOR,API_VERSION);
+               return Version("Provides usermodes +dD to block channel and/or user messages and notices", VF_VENDOR);
        }
-
 };
 
 MODULE_INIT(ModuleDeaf)