]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_auditorium.cpp
Fix the cloaking module on C++98 compilers.
[user/henk/code/inspircd.git] / src / modules / m_auditorium.cpp
index f4c654302bd06b8b803cdde1f5a79a651f3c8b48..0e18d3e36444f22348016b125b48416964a6723f 100644 (file)
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *   Copyright (C) 2013-2014, 2016, 2018 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2013, 2017-2019 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2007-2008, 2010 Craig Edwards <brain@inspircd.org>
+ *   Copyright (C) 2007, 2009 Dennis Friis <peavey@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: Allows for auditorium channels (+u) where nobody can see others joining and parting or the nick list */
+#include "inspircd.h"
+#include "modules/exemption.h"
+#include "modules/names.h"
+#include "modules/who.h"
 
-class AuditoriumMode : public ModeHandler
+class AuditoriumMode : public SimpleChannelModeHandler
 {
  public:
-       AuditoriumMode(InspIRCd* Instance) : ModeHandler(Instance, 'u', 0, 0, false, MODETYPE_CHANNEL, false) { }
-
-       ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, bool)
+       AuditoriumMode(Module* Creator) : SimpleChannelModeHandler(Creator, "auditorium", 'u')
        {
-               if (channel->IsModeSet('u') != adding)
-               {
-                       if (IS_LOCAL(source) && (channel->GetStatus(source) < STATUS_OP))
-                       {
-                               source->WriteNumeric(ERR_CHANOPRIVSNEEDED, "%s %s :Only channel operators may %sset channel mode +u", source->nick.c_str(), channel->name.c_str(), adding ? "" : "un");
-                               return MODEACTION_DENY;
-                       }
-                       else
-                       {
-                               channel->SetMode('u', adding);
-                               return MODEACTION_ALLOW;
-                       }
-               }
-               else
-               {
-                       return MODEACTION_DENY;
-               }
+               ranktoset = ranktounset = OP_VALUE;
        }
 };
 
-class ModuleAuditorium : public Module
+class ModuleAuditorium;
+
+namespace
+{
+
+/** Hook handler for join client protocol events.
+ * This allows us to block join protocol events completely, including all associated messages (e.g. MODE, away-notify AWAY).
+ * This is not the same as OnUserJoin() because that runs only when a real join happens but this runs also when a module
+ * such as delayjoin or hostcycle generates a join.
+ */
+class JoinHook : public ClientProtocol::EventHook
 {
- private:
-       AuditoriumMode* aum;
-       bool ShowOps;
-       bool OperOverride;
+       ModuleAuditorium* const parentmod;
+       bool active;
+
  public:
-       ModuleAuditorium(InspIRCd* Me)
-               : Module(Me)
-       {
-               aum = new AuditoriumMode(ServerInstance);
-               if (!ServerInstance->Modes->AddMode(aum))
-               {
-                       delete aum;
-                       throw ModuleException("Could not add new modes!");
-               }
+       JoinHook(ModuleAuditorium* mod);
+       void OnEventInit(const ClientProtocol::Event& ev) CXX11_OVERRIDE;
+       ModResult OnPreEventSend(LocalUser* user, const ClientProtocol::Event& ev, ClientProtocol::MessageList& messagelist) CXX11_OVERRIDE;
+};
 
-               OnRehash(NULL, "");
+}
 
-               Implementation eventlist[] = { I_OnUserJoin, I_OnUserPart, I_OnUserKick, I_OnUserQuit, I_OnNamesListItem, I_OnRehash, I_OnHostCycle };
-               Me->Modules->Attach(eventlist, this, 7);
+class ModuleAuditorium
+       : public Module
+       , public Names::EventListener
+       , public Who::EventListener
+{
+       CheckExemption::EventProvider exemptionprov;
+       AuditoriumMode aum;
+       bool OpsVisible;
+       bool OpsCanSee;
+       bool OperCanSee;
+       JoinHook joinhook;
 
+ public:
+       ModuleAuditorium()
+               : Names::EventListener(this)
+               , Who::EventListener(this)
+               , exemptionprov(this)
+               , aum(this)
+               , joinhook(this)
+       {
        }
 
-       virtual ~ModuleAuditorium()
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
        {
-               ServerInstance->Modes->DelMode(aum);
-               delete aum;
+               ConfigTag* tag = ServerInstance->Config->ConfValue("auditorium");
+               OpsVisible = tag->getBool("opvisible");
+               OpsCanSee = tag->getBool("opcansee");
+               OperCanSee = tag->getBool("opercansee", true);
        }
 
-       virtual void OnRehash(User* user, const std::string &parameter)
+       Version GetVersion() CXX11_OVERRIDE
        {
-               ConfigReader conf(ServerInstance);
-               ShowOps = conf.ReadFlag("auditorium", "showops", 0);
-               OperOverride = conf.ReadFlag("auditorium", "operoverride", 0);
+               return Version("Adds channel mode u (auditorium) which hides unprivileged users in a channel from each other.", VF_VENDOR);
        }
 
-       virtual Version GetVersion()
+       /* Can they be seen by everyone? */
+       bool IsVisible(Membership* memb)
        {
-               return Version("$Id$", VF_COMMON | VF_VENDOR, API_VERSION);
+               if (!memb->chan->IsModeSet(&aum))
+                       return true;
+
+               ModResult res = CheckExemption::Call(exemptionprov, memb->user, memb->chan, "auditorium-vis");
+               return res.check(OpsVisible && memb->getRank() >= OP_VALUE);
        }
 
-       virtual void OnNamesListItem(User* issuer, User* user, Channel* channel, std::string &prefixes, std::string &nick)
+       /* Can they see this specific membership? */
+       bool CanSee(User* issuer, Membership* memb)
        {
-               if (!channel->IsModeSet('u'))
-                       return;
+               // If user is oper and operoverride is on, don't touch the list
+               if (OperCanSee && issuer->HasPrivPermission("channels/auspex"))
+                       return true;
 
-               /* Some module hid this from being displayed, dont bother */
-               if (nick.empty())
-                       return;
+               // You can always see yourself
+               if (issuer == memb->user)
+                       return true;
 
-               /* If user is oper and operoverride is on, don't touch the list */
-               if (OperOverride && issuer->HasPrivPermission("channels/auspex"))
-                       return;
+               // Can you see the list by permission?
+               ModResult res = CheckExemption::Call(exemptionprov, issuer, memb->chan, "auditorium-see");
+               if (res.check(OpsCanSee && memb->chan->GetPrefixValue(issuer) >= OP_VALUE))
+                       return true;
 
-               if (ShowOps && (issuer != user) && (channel->GetStatus(user) < STATUS_OP))
-               {
-                       /* Showops is set, hide all non-ops from the user, except themselves */
-                       nick.clear();
-                       return;
-               }
-
-               if (!ShowOps && (issuer != user))
-               {
-                       /* ShowOps is not set, hide everyone except the user whos requesting NAMES */
-                       nick.clear();
-                       return;
-               }
+               return false;
        }
 
-       virtual void OnUserJoin(User* user, Channel* channel, bool sync, bool &silent)
+       ModResult OnNamesListItem(LocalUser* issuer, Membership* memb, std::string& prefixes, std::string& nick) CXX11_OVERRIDE
        {
-               if (channel->IsModeSet('u'))
-               {
-                       silent = true;
-                       /* Because we silenced the event, make sure it reaches the user whos joining (but only them of course) */
-                       user->WriteFrom(user, "JOIN %s", channel->name.c_str());
-                       if (ShowOps)
-                               channel->WriteAllExceptSender(user, false, channel->GetStatus(user) >= STATUS_OP ? 0 : '@', "JOIN %s", channel->name.c_str());
-               }
+               if (IsVisible(memb))
+                       return MOD_RES_PASSTHRU;
+
+               if (CanSee(issuer, memb))
+                       return MOD_RES_PASSTHRU;
+
+               // Don't display this user in the NAMES list
+               return MOD_RES_DENY;
        }
 
-       void OnUserPart(User* user, Channel* channel, std::string &partmessage, bool &silent)
+       /** Build CUList for showing this join/part/kick */
+       void BuildExcept(Membership* memb, CUList& excepts)
        {
-               if (channel->IsModeSet('u'))
+               if (IsVisible(memb))
+                       return;
+
+               const Channel::MemberMap& users = memb->chan->GetUsers();
+               for (Channel::MemberMap::const_iterator i = users.begin(); i != users.end(); ++i)
                {
-                       silent = true;
-                       /* Because we silenced the event, make sure it reaches the user whos leaving (but only them of course) */
-                       user->WriteFrom(user, "PART %s%s%s", channel->name.c_str(),
-                                       partmessage.empty() ? "" : " :",
-                                       partmessage.empty() ? "" : partmessage.c_str());
-                       if (ShowOps)
-                       {
-                               channel->WriteAllExceptSender(user, false, channel->GetStatus(user) >= STATUS_OP ? 0 : '@', "PART %s%s%s", channel->name.c_str(), partmessage.empty() ? "" : " :",
-                                               partmessage.empty() ? "" : partmessage.c_str());
-                       }
+                       if (IS_LOCAL(i->first) && !CanSee(i->first, memb))
+                               excepts.insert(i->first);
                }
        }
 
-       void OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent)
+       void OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts) CXX11_OVERRIDE
        {
-               if (chan->IsModeSet('u'))
-               {
-                       silent = true;
-                       /* Send silenced event only to the user being kicked and the user doing the kick */
-                       source->WriteFrom(source, "KICK %s %s %s", chan->name.c_str(), user->nick.c_str(), reason.c_str());
-                       if (ShowOps)
-                               chan->WriteAllExceptSender(source, false, chan->GetStatus(user) >= STATUS_OP ? 0 : '@', "KICK %s %s %s", chan->name.c_str(), user->nick.c_str(), reason.c_str());
-                       if ((!ShowOps) || (chan->GetStatus(user) < STATUS_OP)) /* make sure the target gets the event */
-                               user->WriteFrom(source, "KICK %s %s %s", chan->name.c_str(), user->nick.c_str(), reason.c_str());
-               }
+               BuildExcept(memb, excepts);
        }
 
-       bool OnHostCycle(User* user)
+       void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts) CXX11_OVERRIDE
        {
-               for (UCListIter f = user->chans.begin(); f != user->chans.end(); f++)
-                       if (f->first->IsModeSet('u'))
-                               return true;
-
-               return false;
+               BuildExcept(memb, excepts);
        }
 
-       void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
+       void OnBuildNeighborList(User* source, IncludeChanList& include, std::map<User*, bool>& exception) CXX11_OVERRIDE
        {
-               Command* parthandler = ServerInstance->Parser->GetHandler("PART");
-               std::vector<std::string> to_leave;
-               if (parthandler)
+               for (IncludeChanList::iterator i = include.begin(); i != include.end(); )
                {
-                       for (UCListIter f = user->chans.begin(); f != user->chans.end(); f++)
+                       Membership* memb = *i;
+                       if (IsVisible(memb))
                        {
-                               if (f->first->IsModeSet('u'))
-                                       to_leave.push_back(f->first->name);
+                               ++i;
+                               continue;
                        }
-                       /* We cant do this neatly in one loop, as we are modifying the map we are iterating */
-                       for (std::vector<std::string>::iterator n = to_leave.begin(); n != to_leave.end(); n++)
+
+                       // this channel should not be considered when listing my neighbors
+                       i = include.erase(i);
+                       // however, that might hide me from ops that can see me...
+                       const Channel::MemberMap& users = memb->chan->GetUsers();
+                       for(Channel::MemberMap::const_iterator j = users.begin(); j != users.end(); ++j)
                        {
-                               std::vector<std::string> parameters;
-                               parameters.push_back(*n);
-                               /* This triggers our OnUserPart, above, making the PART silent */
-                               parthandler->Handle(parameters, user);
+                               if (IS_LOCAL(j->first) && CanSee(j->first, memb))
+                                       exception[j->first] = true;
                        }
                }
        }
+
+       ModResult OnWhoLine(const Who::Request& request, LocalUser* source, User* user, Membership* memb, Numeric::Numeric& numeric) CXX11_OVERRIDE
+       {
+               if (!memb)
+                       return MOD_RES_PASSTHRU;
+               if (IsVisible(memb))
+                       return MOD_RES_PASSTHRU;
+               if (CanSee(source, memb))
+                       return MOD_RES_PASSTHRU;
+               return MOD_RES_DENY;
+       }
 };
 
+JoinHook::JoinHook(ModuleAuditorium* mod)
+       : ClientProtocol::EventHook(mod, "JOIN", 10)
+       , parentmod(mod)
+{
+}
+
+void JoinHook::OnEventInit(const ClientProtocol::Event& ev)
+{
+       const ClientProtocol::Events::Join& join = static_cast<const ClientProtocol::Events::Join&>(ev);
+       active = !parentmod->IsVisible(join.GetMember());
+}
+
+ModResult JoinHook::OnPreEventSend(LocalUser* user, const ClientProtocol::Event& ev, ClientProtocol::MessageList& messagelist)
+{
+       if (!active)
+               return MOD_RES_PASSTHRU;
+
+       const ClientProtocol::Events::Join& join = static_cast<const ClientProtocol::Events::Join&>(ev);
+       return ((parentmod->CanSee(user, join.GetMember())) ? MOD_RES_PASSTHRU : MOD_RES_DENY);
+}
+
 MODULE_INIT(ModuleAuditorium)