-/* +------------------------------------+
- * | 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) 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>
*
- * 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(Module* Creator) : ModeHandler(Creator, "auditorium", 'u', PARAM_NONE, MODETYPE_CHANNEL)
+ AuditoriumMode(Module* Creator) : SimpleChannelModeHandler(Creator, "auditorium", 'u')
{
- levelrequired = OP_VALUE;
+ ranktoset = ranktounset = OP_VALUE;
}
+};
- ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding)
- {
- if (channel->IsModeSet('u') != adding)
- {
- channel->SetMode('u', adding);
- return MODEACTION_ALLOW;
- }
- else
- {
- return MODEACTION_DENY;
- }
- }
+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
+}
+
+class ModuleAuditorium
+ : public Module
+ , public Names::EventListener
+ , public Who::EventListener
{
- private:
+ CheckExemption::EventProvider exemptionprov;
AuditoriumMode aum;
- bool ShowOps;
- bool OperOverride;
+ bool OpsVisible;
+ bool OpsCanSee;
+ bool OperCanSee;
+ JoinHook joinhook;
+
public:
ModuleAuditorium()
- : aum(this)
+ : Names::EventListener(this)
+ , Who::EventListener(this)
+ , exemptionprov(this)
+ , aum(this)
+ , joinhook(this)
{
- if (!ServerInstance->Modes->AddMode(&aum))
- throw ModuleException("Could not add new modes!");
-
- OnRehash(NULL);
-
- Implementation eventlist[] = { I_OnUserJoin, I_OnUserPart, I_OnUserKick, I_OnBuildNeighborList, I_OnNamesListItem, I_OnRehash };
- ServerInstance->Modules->Attach(eventlist, this, 6);
-
}
- ~ModuleAuditorium()
+ 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);
}
- void OnRehash(User* user)
+ Version GetVersion() CXX11_OVERRIDE
{
- ConfigReader conf;
- ShowOps = conf.ReadFlag("auditorium", "showops", 0);
- OperOverride = conf.ReadFlag("auditorium", "operoverride", 0);
+ return Version("Provides channel mode +u, auditorium channels where nobody can see others joining and parting or the nick list", VF_VENDOR);
}
- Version GetVersion()
+ /* Can they be seen by everyone? */
+ bool IsVisible(Membership* memb)
{
- return Version("Allows for auditorium channels (+u) where nobody can see others joining and parting or the nick list", 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);
}
- void OnNamesListItem(User* issuer, Membership* memb, std::string &prefixes, std::string &nick)
+ /* Can they see this specific membership? */
+ bool CanSee(User* issuer, Membership* memb)
{
- if (!memb->chan->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 != memb->user) && (memb->getRank() < OP_VALUE))
- {
- /* Showops is set, hide all non-ops from the user, except themselves */
- nick.clear();
- return;
- }
+ return false;
+ }
- if (!ShowOps && (issuer != memb->user))
- {
- /* ShowOps is not set, hide everyone except the user whos requesting NAMES */
- nick.clear();
- return;
- }
+ 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 (!memb->chan->IsModeSet('u'))
- return;
- if (ShowOps && memb->getRank() >= OP_VALUE)
+ if (IsVisible(memb))
return;
- const UserMembList* users = memb->chan->GetUsers();
- for(UserMembCIter i = users->begin(); i != users->end(); i++)
+ const Channel::MemberMap& users = memb->chan->GetUsers();
+ for (Channel::MemberMap::const_iterator i = users.begin(); i != users.end(); ++i)
{
- if (i->first == memb->user || !IS_LOCAL(i->first))
- continue;
- if (ShowOps && i->second->getRank() >= OP_VALUE)
- continue;
- if (OperOverride && i->first->HasPrivPermission("channels/auspex"))
- continue;
- // This is a different user in the channel, local, and not op/oper
- // so, hide the join from them
- excepts.insert(i->first);
+ if (IS_LOCAL(i->first) && !CanSee(i->first, memb))
+ excepts.insert(i->first);
}
}
- void OnUserJoin(Membership* memb, bool sync, bool created, CUList& excepts)
- {
- BuildExcept(memb, excepts);
- }
- void OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts)
+ 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)
+ void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts) CXX11_OVERRIDE
{
BuildExcept(memb, excepts);
}
- void OnBuildNeighborList(User* source, UserChanList &include, std::map<User*,bool> &exception)
+ void OnBuildNeighborList(User* source, IncludeChanList& include, std::map<User*, bool>& exception) CXX11_OVERRIDE
{
- UCListIter i = include.begin();
- while (i != include.end())
+ for (IncludeChanList::iterator i = include.begin(); i != include.end(); )
{
- Channel* c = *i++;
- if (c->IsModeSet('u'))
- include.erase(c);
+ 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)