Sync helpop chmodes s and p with docs

[user/henk/code/inspircd.git] / src / modules / m_auditorium.cpp

diff --git a/src/modules/m_auditorium.cpp b/src/modules/m_auditorium.cpp
index 7ad7ba1a3d8d684fc9609cdd764f206572d66687..0e18d3e36444f22348016b125b48416964a6723f 100644 (file)
--- a/src/modules/m_auditorium.cpp
+++ b/src/modules/m_auditorium.cpp
@@ -1,10 +1,13 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
+ *   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) 2007-2008 Craig Edwards <craigedwards@brainbox.cc>
- *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
- *   Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
+ *   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 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
@@ -21,25 +24,61 @@
 
 
 #include "inspircd.h"
+#include "modules/exemption.h"
+#include "modules/names.h"
+#include "modules/who.h"
 
 class AuditoriumMode : public SimpleChannelModeHandler
 {
  public:
        AuditoriumMode(Module* Creator) : SimpleChannelModeHandler(Creator, "auditorium", 'u')
        {
-               levelrequired = OP_VALUE;
+               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
+{
+       ModuleAuditorium* const parentmod;
+       bool active;
+
+ public:
+       JoinHook(ModuleAuditorium* mod);
+       void OnEventInit(const ClientProtocol::Event& ev) CXX11_OVERRIDE;
+       ModResult OnPreEventSend(LocalUser* user, const ClientProtocol::Event& ev, ClientProtocol::MessageList& messagelist) CXX11_OVERRIDE;
+};
+
+}
+
+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() : aum(this)
+       ModuleAuditorium()
+               : Names::EventListener(this)
+               , Who::EventListener(this)
+               , exemptionprov(this)
+               , aum(this)
+               , joinhook(this)
        {
        }
 
@@ -53,7 +92,7 @@ class ModuleAuditorium : public Module
 
        Version GetVersion() CXX11_OVERRIDE
        {
-               return Version("Allows for auditorium channels (+u) where nobody can see others joining and parting or the nick list", VF_VENDOR);
+               return Version("Adds channel mode u (auditorium) which hides unprivileged users in a channel from each other.", VF_VENDOR);
        }
 
        /* Can they be seen by everyone? */
@@ -62,7 +101,7 @@ class ModuleAuditorium : public Module
                if (!memb->chan->IsModeSet(&aum))
                        return true;
 
-               ModResult res = ServerInstance->OnCheckExemption(memb->user, memb->chan, "auditorium-vis");
+               ModResult res = CheckExemption::Call(exemptionprov, memb->user, memb->chan, "auditorium-vis");
                return res.check(OpsVisible && memb->getRank() >= OP_VALUE);
        }
 
@@ -78,14 +117,14 @@ class ModuleAuditorium : public Module
                        return true;
 
                // Can you see the list by permission?
-               ModResult res = ServerInstance->OnCheckExemption(issuer,memb->chan,"auditorium-see");
+               ModResult res = CheckExemption::Call(exemptionprov, issuer, memb->chan, "auditorium-see");
                if (res.check(OpsCanSee && memb->chan->GetPrefixValue(issuer) >= OP_VALUE))
                        return true;
 
                return false;
        }
 
-       ModResult OnNamesListItem(User* issuer, Membership* memb, std::string& prefixes, std::string& nick) CXX11_OVERRIDE
+       ModResult OnNamesListItem(LocalUser* issuer, Membership* memb, std::string& prefixes, std::string& nick) CXX11_OVERRIDE
        {
                if (IsVisible(memb))
                        return MOD_RES_PASSTHRU;
@@ -111,11 +150,6 @@ class ModuleAuditorium : public Module
                }
        }
 
-       void OnUserJoin(Membership* memb, bool sync, bool created, CUList& excepts) CXX11_OVERRIDE
-       {
-               BuildExcept(memb, excepts);
-       }
-
        void OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts) CXX11_OVERRIDE
        {
                BuildExcept(memb, excepts);
@@ -149,16 +183,37 @@ class ModuleAuditorium : public Module
                }
        }
 
-       void OnSendWhoLine(User* source, const std::vector<std::string>& params, User* user, Membership* memb, std::string& line) CXX11_OVERRIDE
+       ModResult OnWhoLine(const Who::Request& request, LocalUser* source, User* user, Membership* memb, Numeric::Numeric& numeric) CXX11_OVERRIDE
        {
                if (!memb)
-                       return;
+                       return MOD_RES_PASSTHRU;
                if (IsVisible(memb))
-                       return;
+                       return MOD_RES_PASSTHRU;
                if (CanSee(source, memb))
-                       return;
-               line.clear();
+                       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)