-/* +------------------------------------+
- * | 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) 2013, 2017-2019 Sadie Powell <sadie@witchery.services>
+ * Copyright (C) 2012-2015, 2018 Attila Molnar <attilamolnar@hush.com>
+ * Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
+ * Copyright (C) 2010 Jens Voss <DukePyrolator@anope.org>
+ * Copyright (C) 2009 Matt Smith <dz@inspircd.org>
+ * Copyright (C) 2009 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>
*
- * 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 <stdarg.h>
-/* $ModDesc: Allows for delay-join channels (+D) where users dont appear to join until they speak */
+#include "inspircd.h"
+#include "modules/ctctags.h"
+#include "modules/names.h"
class DelayJoinMode : public ModeHandler
{
- CUList empty;
- Module* Creator;
- public:
- DelayJoinMode(InspIRCd* Instance, Module* Parent) : ModeHandler(Instance, 'D', 0, 0, false, MODETYPE_CHANNEL, false), Creator(Parent) { }
+ private:
+ LocalIntExt& unjoined;
- ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding)
+ public:
+ DelayJoinMode(Module* Parent, LocalIntExt& ext)
+ : ModeHandler(Parent, "delayjoin", 'D', PARAM_NONE, MODETYPE_CHANNEL)
+ , unjoined(ext)
{
- if (channel->IsModeSet('D') != adding)
- {
- if (IS_LOCAL(source) && (channel->GetStatus(source) < STATUS_OP))
- {
- source->WriteServ("482 %s %s :Only channel operators may %sset channel mode +D", source->nick, channel->name, adding ? "" : "un");
- return MODEACTION_DENY;
- }
- else
- {
- if (channel->IsModeSet('D'))
- {
- /* Make all delayed join users visible, or if an op removes +D
- * while users exist that havent spoken, they remain permenantly
- * invisible on this channel!
- */
- CUList* names = channel->GetUsers();
- for (CUListIter n = names->begin(); n != names->end(); ++n)
- Creator->OnText(n->first, channel, TYPE_CHANNEL, "", 0, empty);
- }
- channel->SetMode('D', adding);
- return MODEACTION_ALLOW;
- }
- }
- else
- {
- return MODEACTION_DENY;
- }
+ ranktoset = ranktounset = OP_VALUE;
}
+
+ ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string& parameter, bool adding) CXX11_OVERRIDE;
+ void RevealUser(User* user, Channel* chan);
};
-class ModuleDelayJoin : public Module
+
+namespace
{
- private:
- DelayJoinMode* djm;
- CUList nl;
+
+/** 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 hostcycle generates a join.
+ */
+class JoinHook : public ClientProtocol::EventHook
+{
+ const LocalIntExt& unjoined;
+
public:
- ModuleDelayJoin(InspIRCd* Me)
- : Module(Me)
+ JoinHook(Module* mod, const LocalIntExt& unjoinedref)
+ : ClientProtocol::EventHook(mod, "JOIN", 10)
+ , unjoined(unjoinedref)
{
- djm = new DelayJoinMode(ServerInstance, this);
- if (!ServerInstance->AddMode(djm))
- throw ModuleException("Could not add new modes!");
- }
-
- virtual ~ModuleDelayJoin()
- {
- ServerInstance->Modes->DelMode(djm);
- DELETE(djm);
}
- void Prioritize()
+ ModResult OnPreEventSend(LocalUser* user, const ClientProtocol::Event& ev, ClientProtocol::MessageList& messagelist) CXX11_OVERRIDE
{
- /* To ensure that we get priority over namesx for names list generation */
- Module* namesx = ServerInstance->Modules->Find("m_namesx.so");
- ServerInstance->Modules->SetPriority(this, I_OnUserList, PRIO_BEFORE, &namesx);
+ const ClientProtocol::Events::Join& join = static_cast<const ClientProtocol::Events::Join&>(ev);
+ const Membership* const memb = join.GetMember();
+ const User* const u = memb->user;
+ if ((unjoined.get(memb)) && (u != user))
+ return MOD_RES_DENY;
+ return MOD_RES_PASSTHRU;
}
+};
- virtual Version GetVersion()
- {
- return Version(1, 1, 0, 0, VF_COMMON | VF_VENDOR, API_VERSION);
- }
+}
- void Implements(char* List)
+class ModuleDelayJoin
+ : public Module
+ , public CTCTags::EventListener
+ , public Names::EventListener
+{
+ public:
+ LocalIntExt unjoined;
+ JoinHook joinhook;
+ DelayJoinMode djm;
+
+ ModuleDelayJoin()
+ : CTCTags::EventListener(this)
+ , Names::EventListener(this)
+ , unjoined("delayjoin", ExtensionItem::EXT_MEMBERSHIP, this)
+ , joinhook(this, unjoined)
+ , djm(this, unjoined)
{
- List[I_OnUserJoin] = List[I_OnUserPart] = List[I_OnUserKick] = List[I_OnUserQuit] = List[I_OnUserList] = List[I_OnText] = 1;
}
- virtual int OnUserList(User* user, Channel* Ptr, CUList* &nameslist)
- {
- CUList* newlist = nameslist ? nameslist : Ptr->GetUsers();
-
- nl.clear();
-
- /* For +D channels ... */
- if (Ptr->IsModeSet('D'))
- {
- std::string key("delayjoin_");
- key.append(Ptr->name);
-
- /* Modify the names list, erasing users with the delay join metadata
- * for this channel (havent spoken yet)
- */
- for (CUListIter n = newlist->begin(); n != newlist->end(); ++n)
- {
- if (!n->first->GetExt(key))
- nl.insert(*n);
- }
-
- /* Always show self */
- nl[user] = user->nick;
- nameslist = &nl;
- }
- return 0;
- }
+ Version GetVersion() CXX11_OVERRIDE;
+ ModResult OnNamesListItem(LocalUser* issuer, Membership*, std::string& prefixes, std::string& nick) CXX11_OVERRIDE;
+ void OnUserJoin(Membership*, bool, bool, CUList&) CXX11_OVERRIDE;
+ void CleanUser(User* user);
+ void OnUserPart(Membership*, std::string &partmessage, CUList&) CXX11_OVERRIDE;
+ void OnUserKick(User* source, Membership*, const std::string &reason, CUList&) CXX11_OVERRIDE;
+ void OnBuildNeighborList(User* source, IncludeChanList& include, std::map<User*, bool>& exception) CXX11_OVERRIDE;
+ void OnUserMessage(User* user, const MessageTarget& target, const MessageDetails& details) CXX11_OVERRIDE;
+ void OnUserTagMessage(User* user, const MessageTarget& target, const CTCTags::TagMessageDetails& details) CXX11_OVERRIDE;
+ ModResult OnRawMode(User* user, Channel* channel, ModeHandler* mh, const std::string& param, bool adding) CXX11_OVERRIDE;
+};
- virtual void OnUserJoin(User* user, Channel* channel, bool &silent)
- {
- if (channel->IsModeSet('D'))
- {
- 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);
-
- /* This metadata tells the module the user is delayed join on this specific channel */
- user->Extend(std::string("delayjoin_")+channel->name);
-
- /* This metadata tells the module the user is delayed join on at least one (or more) channels.
- * It is only cleared when the user is no longer on ANY +D channels.
- */
- if (!user->GetExt("delayjoin"))
- user->Extend("delayjoin");
- }
- }
+ModeAction DelayJoinMode::OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding)
+{
+ /* no change */
+ if (channel->IsModeSet(this) == adding)
+ return MODEACTION_DENY;
- void OnUserPart(User* user, Channel* channel, const std::string &partmessage, bool &silent)
+ if (!adding)
{
- if (channel->IsModeSet('D'))
- {
- if (user->GetExt(std::string("delayjoin_")+channel->name))
- {
- 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, partmessage.empty() ? "" : " :", partmessage.empty() ? "" : partmessage.c_str());
- }
- }
+ /*
+ * Make all users visible, as +D is being removed. If we don't do this,
+ * they remain permanently invisible on this channel!
+ */
+ const Channel::MemberMap& users = channel->GetUsers();
+ for (Channel::MemberMap::const_iterator n = users.begin(); n != users.end(); ++n)
+ RevealUser(n->first, channel);
}
+ channel->SetMode(this, adding);
+ return MODEACTION_ALLOW;
+}
- void OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent)
- {
- if (chan->IsModeSet('D'))
- {
- /* Send silenced event only to the user being kicked and the user doing the kick */
- if (user->GetExt(std::string("delayjoin_")+chan->name))
- {
- silent = true;
- user->WriteFrom(source, "KICK %s %s %s", chan->name, user->nick, reason.c_str());
- }
- }
- }
+Version ModuleDelayJoin::GetVersion()
+{
+ return Version("Adds channel mode D (delayjoin) which hides JOIN messages from users until they speak.", VF_VENDOR);
+}
- void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
- {
- Command* parthandler = ServerInstance->Parser->GetHandler("PART");
- const char* parameters[2];
- if (parthandler && user->GetExt("delayjoin"))
- {
- for (UCListIter f = user->chans.begin(); f != user->chans.end(); f++)
- {
- parameters[0] = f->first->name;
- /* This triggers our OnUserPart, above, making the PART silent */
- parthandler->Handle(parameters, 1, user);
- }
- }
- }
+ModResult ModuleDelayJoin::OnNamesListItem(LocalUser* issuer, Membership* memb, std::string& prefixes, std::string& nick)
+{
+ /* don't prevent the user from seeing themself */
+ if (issuer == memb->user)
+ return MOD_RES_PASSTHRU;
- void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list)
- {
- if (target_type != TYPE_CHANNEL)
- return;
+ /* If the user is hidden by delayed join, hide them from the NAMES list */
+ if (unjoined.get(memb))
+ return MOD_RES_DENY;
- Channel* channel = (Channel*) dest;
+ return MOD_RES_PASSTHRU;
+}
- if (!user->GetExt(std::string("delayjoin_")+channel->name))
- return;
+static void populate(CUList& except, Membership* memb)
+{
+ 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;
+ except.insert(i->first);
+ }
+}
- /* Display the join to everyone else (the user who joined got it earlier) */
- this->WriteCommonFrom(user, channel, "JOIN %s", channel->name);
+void ModuleDelayJoin::OnUserJoin(Membership* memb, bool sync, bool created, CUList& except)
+{
+ if (memb->chan->IsModeSet(djm))
+ unjoined.set(memb, 1);
+}
- /* Shrink off the neccessary metadata for a specific channel */
- user->Shrink(std::string("delayjoin_")+channel->name);
+void ModuleDelayJoin::OnUserPart(Membership* memb, std::string &partmessage, CUList& except)
+{
+ if (unjoined.set(memb, 0))
+ populate(except, memb);
+}
- /* Check if the user is left on any other +D channels, if so don't take away the
- * metadata that says theyre on one or more channels
- */
- for (UCListIter f = user->chans.begin(); f != user->chans.end(); f++)
- if (f->first->IsModeSet('D'))
- return;
+void ModuleDelayJoin::OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except)
+{
+ if (unjoined.set(memb, 0))
+ populate(except, memb);
+}
- user->Shrink("delayjoin");
+void ModuleDelayJoin::OnBuildNeighborList(User* source, IncludeChanList& include, std::map<User*, bool>& exception)
+{
+ for (IncludeChanList::iterator i = include.begin(); i != include.end(); )
+ {
+ Membership* memb = *i;
+ if (unjoined.get(memb))
+ i = include.erase(i);
+ else
+ ++i;
}
+}
- void WriteCommonFrom(User *user, Channel* channel, const char* text, ...)
- {
- va_list argsPtr;
- char textbuffer[MAXBUF];
- char tb[MAXBUF];
+void ModuleDelayJoin::OnUserTagMessage(User* user, const MessageTarget& target, const CTCTags::TagMessageDetails& details)
+{
+ if (target.type != MessageTarget::TYPE_CHANNEL)
+ return;
- va_start(argsPtr, text);
- vsnprintf(textbuffer, MAXBUF, text, argsPtr);
- va_end(argsPtr);
- snprintf(tb,MAXBUF,":%s %s",user->GetFullHost(),textbuffer);
+ Channel* channel = target.Get<Channel>();
+ djm.RevealUser(user, channel);
+}
- CUList *ulist = channel->GetUsers();
+void ModuleDelayJoin::OnUserMessage(User* user, const MessageTarget& target, const MessageDetails& details)
+{
+ if (target.type != MessageTarget::TYPE_CHANNEL)
+ return;
- for (CUList::iterator i = ulist->begin(); i != ulist->end(); i++)
- {
- /* User doesnt get a JOIN sent to themselves */
- if (user == i->first)
- continue;
+ Channel* channel = target.Get<Channel>();
+ djm.RevealUser(user, channel);
+}
- /* Users with a visibility state that hides them dont appear */
- if (user->Visibility && !user->Visibility->VisibleTo(i->first))
- continue;
+void DelayJoinMode::RevealUser(User* user, Channel* chan)
+{
+ Membership* memb = chan->GetUser(user);
+ if (!memb || !unjoined.set(memb, 0))
+ return;
+
+ /* Display the join to everyone else (the user who joined got it earlier) */
+ CUList except_list;
+ except_list.insert(user);
+ ClientProtocol::Events::Join joinevent(memb);
+ chan->Write(joinevent, 0, except_list);
+}
+
+/* make the user visible if they receive any mode change */
+ModResult ModuleDelayJoin::OnRawMode(User* user, Channel* channel, ModeHandler* mh, const std::string& param, bool adding)
+{
+ if (!channel || param.empty())
+ return MOD_RES_PASSTHRU;
- i->first->Write(std::string(tb));
- }
- }
+ // If not a prefix mode then we got nothing to do here
+ if (!mh->IsPrefixMode())
+ return MOD_RES_PASSTHRU;
-};
+ User* dest;
+ if (IS_LOCAL(user))
+ dest = ServerInstance->FindNickOnly(param);
+ else
+ dest = ServerInstance->FindNick(param);
-MODULE_INIT(ModuleDelayJoin)
+ if (!dest)
+ return MOD_RES_PASSTHRU;
+
+ djm.RevealUser(dest, channel);
+ return MOD_RES_PASSTHRU;
+}
+MODULE_INIT(ModuleDelayJoin)
projects / user / henk / code / inspircd.git / blobdiff