]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_auditorium.cpp
Sync helpop chmodes s and p with docs
[user/henk/code/inspircd.git] / src / modules / m_auditorium.cpp
index 419738ea74cc8b2ec3cd058bc021e7328f81833f..0e18d3e36444f22348016b125b48416964a6723f 100644 (file)
@@ -1 +1,219 @@
-/*       +------------------------------------+\r *       | Inspire Internet Relay Chat Daemon |\r *       +------------------------------------+\r *\r *  InspIRCd: (C) 2002-2007 InspIRCd Development Team\r * See: http://www.inspircd.org/wiki/index.php/Credits\r *\r * This program is free but copyrighted software; see\r *            the file COPYING for details.\r *\r * ---------------------------------------------------\r */\r\r#include "inspircd.h"\r#include "users.h"\r#include "channels.h"\r#include "modules.h"\r\r/* $ModDesc: Allows for auditorium channels (+u) where nobody can see others joining and parting or the nick list */\r\rclass AuditoriumMode : public ModeHandler\r{\r public:\r   AuditoriumMode(InspIRCd* Instance) : ModeHandler(Instance, 'u', 0, 0, false, MODETYPE_CHANNEL, false) { }\r\r     ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string &parameter, bool adding)\r {\r              if (channel->IsModeSet('u') != adding)\r         {\r                      if (IS_LOCAL(source) && (channel->GetStatus(source) < STATUS_OP))\r                      {\r                              source->WriteServ("482 %s %s :Only channel operators may %sset channel mode +u", source->nick, channel->name, adding ? "" : "un");\r                             return MODEACTION_DENY;\r                        }\r                      else\r                   {\r                              channel->SetMode('u', adding);\r                         return MODEACTION_ALLOW;\r                       }\r              }\r              else\r           {\r                      return MODEACTION_DENY;\r                }\r      }\r};\r\rclass ModuleAuditorium : public Module\r{\r private:\r       AuditoriumMode* aum;\r   bool ShowOps;\r  CUList nl;\r     CUList except_list;\r public:\r   ModuleAuditorium(InspIRCd* Me)\r         : Module(Me)\r   {\r              aum = new AuditoriumMode(ServerInstance);\r              if (!ServerInstance->AddMode(aum, 'u'))\r                        throw ModuleException("Could not add new modes!");\r             OnRehash(NULL, "");\r    }\r      \r       virtual ~ModuleAuditorium()\r    {\r              ServerInstance->Modes->DelMode(aum);\r           DELETE(aum);\r   }\r\r     virtual void OnRehash(userrec* user, const std::string &parameter)\r     {\r              ConfigReader conf(ServerInstance);\r             ShowOps = conf.ReadFlag("auditorium", "showops", 0);\r   }\r\r     Priority Prioritize()\r  {\r              /* To ensure that we get priority over namesx for names list generation on +u channels */\r              return (Priority)ServerInstance->PriorityBefore("m_namesx.so");\r        }\r\r     virtual Version GetVersion()\r   {\r              return Version(1, 1, 0, 0, VF_COMMON | VF_VENDOR, API_VERSION);\r        }\r\r     void Implements(char* List)\r    {\r              List[I_OnUserJoin] = List[I_OnUserPart] = List[I_OnUserKick] = List[I_OnUserQuit] = List[I_OnUserList] = List[I_OnRehash] = 1;\r }\r\r     virtual int OnUserList(userrec* user, chanrec* Ptr, CUList* &nameslist)\r        {\r              if (Ptr->IsModeSet('u'))\r               {\r                      if (ShowOps)\r                   {\r                              /* Leave the names list alone, theyre an op\r                             * doing /names on the channel after joining it\r                                 */\r                            if (Ptr->GetStatus(user) >= STATUS_OP)\r                         {\r                                      nameslist = Ptr->GetUsers();\r                                   return 0;\r                              }\r\r                             /* Show all the opped users */\r                         nl = *(Ptr->GetOppedUsers());\r                          nl[user] = user->nick;\r                         nameslist = &nl;\r                               return 0;\r                      }\r                      else\r                   {\r                              /* HELLOOO, IS ANYBODY THERE? -- nope, just us. */\r                             user->WriteServ("353 %s = %s :%s", user->nick, Ptr->name, user->nick);\r                         user->WriteServ("366 %s %s :End of /NAMES list.", user->nick, Ptr->name);\r                              return 1;\r                      }\r              }\r              return 0;\r      }\r      \r       virtual void OnUserJoin(userrec* user, chanrec* channel, bool &silent)\r {\r              if (channel->IsModeSet('u'))\r           {\r                      silent = true;\r                 /* Because we silenced the event, make sure it reaches the user whos joining (but only them of course) */\r                      user->WriteFrom(user, "JOIN %s", channel->name);\r                       if (ShowOps)\r                           channel->WriteAllExcept(user, false, channel->GetStatus(user) >= STATUS_OP ? 0 : '@', except_list, "JOIN %s", channel->name);\r          }\r      }\r\r     void OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage, bool &silent)\r {\r              if (channel->IsModeSet('u'))\r           {\r                      silent = true;\r                 /* Because we silenced the event, make sure it reaches the user whos leaving (but only them of course) */\r                      user->WriteFrom(user, "PART %s%s%s", channel->name,\r                                    partmessage.empty() ? "" : " :",\r                                       partmessage.empty() ? "" : partmessage.c_str());\r                       if (ShowOps)\r                   {\r                              channel->WriteAllExcept(user, false, channel->GetStatus(user) >= STATUS_OP ? 0 : '@', except_list, "PART %s%s%s", channel->name, partmessage.empty() ? "" : " :",\r                                              partmessage.empty() ? "" : partmessage.c_str());\r                       }\r              }\r      }\r\r     void OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason, bool &silent)\r        {\r              if (chan->IsModeSet('u'))\r              {\r                      silent = true;\r                 /* Send silenced event only to the user being kicked and the user doing the kick */\r                    source->WriteFrom(source, "KICK %s %s %s", chan->name, user->nick, reason.c_str());\r                    if (ShowOps)\r                           chan->WriteAllExcept(source, false, chan->GetStatus(source) >= STATUS_OP ? 0 : '@', except_list, "KICK %s %s %s", chan->name, user->nick, reason.c_str());\r                     else\r                           user->WriteFrom(source, "KICK %s %s %s", chan->name, user->nick, reason.c_str());\r              }\r      }\r\r     void OnUserQuit(userrec* user, const std::string &reason, const std::string &oper_message)\r     {\r              command_t* parthandler = ServerInstance->Parser->GetHandler("PART");\r           std::vector<std::string> to_leave;\r             const char* parameters[2];\r             if (parthandler)\r               {\r                      for (UCListIter f = user->chans.begin(); f != user->chans.end(); f++)\r                  {\r                              if (f->first->IsModeSet('u'))\r                                  to_leave.push_back(f->first->name);\r                    }\r                      /* We cant do this neatly in one loop, as we are modifying the map we are iterating */\r                 for (std::vector<std::string>::iterator n = to_leave.begin(); n != to_leave.end(); n++)\r                        {\r                              parameters[0] = n->c_str();\r                            /* This triggers our OnUserPart, above, making the PART silent */\r                              parthandler->Handle(parameters, 1, user);\r                      }\r              }\r      }\r};\r\rMODULE_INIT(ModuleAuditorium)\r
\ No newline at end of file
+/*
+ * 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) 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
+ * 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 "modules/exemption.h"
+#include "modules/names.h"
+#include "modules/who.h"
+
+class AuditoriumMode : public SimpleChannelModeHandler
+{
+ public:
+       AuditoriumMode(Module* Creator) : SimpleChannelModeHandler(Creator, "auditorium", 'u')
+       {
+               ranktoset = ranktounset = OP_VALUE;
+       }
+};
+
+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()
+               : Names::EventListener(this)
+               , Who::EventListener(this)
+               , exemptionprov(this)
+               , aum(this)
+               , joinhook(this)
+       {
+       }
+
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
+       {
+               ConfigTag* tag = ServerInstance->Config->ConfValue("auditorium");
+               OpsVisible = tag->getBool("opvisible");
+               OpsCanSee = tag->getBool("opcansee");
+               OperCanSee = tag->getBool("opercansee", true);
+       }
+
+       Version GetVersion() CXX11_OVERRIDE
+       {
+               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? */
+       bool IsVisible(Membership* memb)
+       {
+               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);
+       }
+
+       /* Can they see this specific membership? */
+       bool CanSee(User* issuer, Membership* memb)
+       {
+               // If user is oper and operoverride is on, don't touch the list
+               if (OperCanSee && issuer->HasPrivPermission("channels/auspex"))
+                       return true;
+
+               // You can always see yourself
+               if (issuer == memb->user)
+                       return true;
+
+               // 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;
+
+               return false;
+       }
+
+       ModResult OnNamesListItem(LocalUser* issuer, Membership* memb, std::string& prefixes, std::string& nick) CXX11_OVERRIDE
+       {
+               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;
+       }
+
+       /** Build CUList for showing this join/part/kick */
+       void BuildExcept(Membership* memb, CUList& excepts)
+       {
+               if (IsVisible(memb))
+                       return;
+
+               const Channel::MemberMap& users = memb->chan->GetUsers();
+               for (Channel::MemberMap::const_iterator i = users.begin(); i != users.end(); ++i)
+               {
+                       if (IS_LOCAL(i->first) && !CanSee(i->first, memb))
+                               excepts.insert(i->first);
+               }
+       }
+
+       void OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts) CXX11_OVERRIDE
+       {
+               BuildExcept(memb, excepts);
+       }
+
+       void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts) CXX11_OVERRIDE
+       {
+               BuildExcept(memb, excepts);
+       }
+
+       void OnBuildNeighborList(User* source, IncludeChanList& include, std::map<User*, bool>& exception) CXX11_OVERRIDE
+       {
+               for (IncludeChanList::iterator i = include.begin(); i != include.end(); )
+               {
+                       Membership* memb = *i;
+                       if (IsVisible(memb))
+                       {
+                               ++i;
+                               continue;
+                       }
+
+                       // 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)
+                       {
+                               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)