]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_delayjoin.cpp
Implement support for IRCv3 client-to-client tags.
[user/henk/code/inspircd.git] / src / modules / m_delayjoin.cpp
index 23e6317ad8425f92cc3c732bcbd7d90b2f2d0168..469f334393c36142d4976c01453322eba26b0f9f 100644 (file)
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *   Copyright (C) 2010 Jens Voss <DukePyrolator@anope.org>
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2007-2008 Craig Edwards <craigedwards@brainbox.cc>
  *
- * 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>
+#include "modules/ctctags.h"
 
 class DelayJoinMode : public ModeHandler
 {
  private:
-       CUList empty;
-       Module* Creator;
+       LocalIntExt& unjoined;
+
  public:
-       DelayJoinMode(InspIRCd* Instance, Module* Parent) : ModeHandler(Instance, 'D', 0, 0, false, MODETYPE_CHANNEL, false), Creator(Parent) {};
+       DelayJoinMode(Module* Parent, LocalIntExt& ext)
+               : ModeHandler(Parent, "delayjoin", 'D', PARAM_NONE, MODETYPE_CHANNEL)
+               , unjoined(ext)
+       {
+               ranktoset = ranktounset = OP_VALUE;
+       }
 
-       ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, bool);
+       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->Modes->AddMode(djm))
-                       throw ModuleException("Could not add new modes!");
-               Implementation eventlist[] = { I_OnUserJoin, I_OnUserPart, I_OnUserKick, I_OnUserQuit, I_OnNamesListItem, I_OnText };
-               ServerInstance->Modules->Attach(eventlist, this, 6);
        }
-       virtual ~ModuleDelayJoin();
-       virtual Version GetVersion();
-       virtual void OnNamesListItem(User* issuer, User* user, Channel* channel, std::string &prefixes, std::string &nick);
-       virtual void OnUserJoin(User* user, Channel* channel, bool sync, bool &silent);
-       bool OnHostCycle(User* user);
-       void OnUserPart(User* user, Channel* channel, std::string &partmessage, bool &silent);
-       void OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent);
-       void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message);
-       void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
-       void WriteCommonFrom(User *user, Channel* channel, const char* text, ...) CUSTOM_PRINTF(4, 5);
+
+       ModResult OnPreEventSend(LocalUser* user, const ClientProtocol::Event& ev, ClientProtocol::MessageList& messagelist) CXX11_OVERRIDE
+       {
+               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;
+       }
 };
 
-/* $ModDesc: Allows for delay-join channels (+D) where users dont appear to join until they speak */
+}
 
-ModeAction DelayJoinMode::OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, bool)
+class ModuleDelayJoin 
+       : public Module
+       , public CTCTags::EventListener
 {
-       if (channel->IsModeSet('D') != adding)
-       {
-               if (IS_LOCAL(source) && (channel->GetStatus(source) < STATUS_OP))
-               {
-                       source->WriteNumeric(ERR_CHANOPRIVSNEEDED, "%s %s :Only channel operators may %sset channel mode +D", source->nick.c_str(), channel->name.c_str(), adding ? "" : "un");
-                       return MODEACTION_DENY;
-               }
-               else
-               {
-                       if (channel->IsModeSet('D'))
-                       {
-                               /*
-                                * Make all users visible, as +D is being removed. If we don't do this,
-                                * they remain permanently 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
+ public:
+       LocalIntExt unjoined;
+       JoinHook joinhook;
+       DelayJoinMode djm;
+
+       ModuleDelayJoin()
+               : CTCTags::EventListener(this)
+               , unjoined("delayjoin", ExtensionItem::EXT_MEMBERSHIP, this)
+               , joinhook(this, unjoined)
+               , djm(this, unjoined)
        {
-               return MODEACTION_DENY;
        }
-}
 
-ModuleDelayJoin::~ModuleDelayJoin()
+       Version GetVersion() CXX11_OVERRIDE;
+       ModResult OnNamesListItem(User* 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;
+};
+
+ModeAction DelayJoinMode::OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding)
 {
-       ServerInstance->Modes->DelMode(djm);
-       delete djm;
+       /* no change */
+       if (channel->IsModeSet(this) == adding)
+               return MODEACTION_DENY;
+
+       if (!adding)
+       {
+               /*
+                * 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;
 }
 
 Version ModuleDelayJoin::GetVersion()
 {
-       return Version("$Id$", VF_COMMON | VF_VENDOR, API_VERSION);
+       return Version("Allows for delay-join channels (+D) where users don't appear to join until they speak", VF_VENDOR);
 }
 
-void ModuleDelayJoin::OnNamesListItem(User* issuer, User* user, Channel* channel, std::string &prefixes, std::string &nick)
+ModResult ModuleDelayJoin::OnNamesListItem(User* issuer, Membership* memb, std::string& prefixes, std::string& nick)
 {
-       if (!channel->IsModeSet('D'))
-               return;
-
-       if (nick.empty())
-               return;
+       /* don't prevent the user from seeing themself */
+       if (issuer == memb->user)
+               return MOD_RES_PASSTHRU;
 
        /* If the user is hidden by delayed join, hide them from the NAMES list */
-       std::string key("delayjoin_");
-       key.append(channel->name);
+       if (unjoined.get(memb))
+               return MOD_RES_DENY;
 
-       if (user->GetExt(key))
-               nick.clear();
+       return MOD_RES_PASSTHRU;
 }
 
-void ModuleDelayJoin::OnUserJoin(User* user, Channel* channel, bool sync, bool &silent)
+static void populate(CUList& except, Membership* memb)
 {
-       if (channel->IsModeSet('D'))
+       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 joining (but only them of course) */
-               user->WriteFrom(user, "JOIN %s", channel->name.c_str());
-
-               /* This metadata tells the module the user is delayed join on this specific channel */
-               user->Extend("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");
+               if (i->first == memb->user || !IS_LOCAL(i->first))
+                       continue;
+               except.insert(i->first);
        }
 }
 
-void ModuleDelayJoin::OnUserPart(User* user, Channel* channel, std::string &partmessage, bool &silent)
+void ModuleDelayJoin::OnUserJoin(Membership* memb, bool sync, bool created, CUList& except)
 {
-       if (channel->IsModeSet('D'))
-       {
-               if (user->GetExt("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.c_str(), partmessage.empty() ? "" : " :", partmessage.empty() ? "" : partmessage.c_str());
-               }
-       }
+       if (memb->chan->IsModeSet(djm))
+               unjoined.set(memb, 1);
 }
 
-void ModuleDelayJoin::OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent)
+void ModuleDelayJoin::OnUserPart(Membership* memb, std::string &partmessage, CUList& except)
 {
-       if (chan->IsModeSet('D'))
-       {
-               /* Send silenced event only to the user being kicked and the user doing the kick */
-               if (user->GetExt("delayjoin_"+chan->name))
-               {
-                       silent = true;
-                       user->WriteFrom(source, "KICK %s %s %s", chan->name.c_str(), user->nick.c_str(), reason.c_str());
-               }
-       }
+       if (unjoined.set(memb, 0))
+               populate(except, memb);
 }
 
-bool ModuleDelayJoin::OnHostCycle(User* user)
+void ModuleDelayJoin::OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except)
 {
-       return user->GetExt("delayjoin");
+       if (unjoined.set(memb, 0))
+               populate(except, memb);
 }
 
-void ModuleDelayJoin::OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
+void ModuleDelayJoin::OnBuildNeighborList(User* source, IncludeChanList& include, std::map<User*, bool>& exception)
 {
-       Command* parthandler = ServerInstance->Parser->GetHandler("PART");
-       if (parthandler && user->GetExt("delayjoin"))
+       for (IncludeChanList::iterator i = include.begin(); i != include.end(); )
        {
-               for (UCListIter f = user->chans.begin(); f != user->chans.end(); f++)
-               {
-                       std::vector<std::string> parameters;
-                       parameters.push_back(f->first->name);
-                       /* This triggers our OnUserPart, above, making the PART silent */
-                       parthandler->Handle(parameters, user);
-               }
+               Membership* memb = *i;
+               if (unjoined.get(memb))
+                       i = include.erase(i);
+               else
+                       ++i;
        }
 }
 
-void ModuleDelayJoin::OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list)
+void ModuleDelayJoin::OnUserTagMessage(User* user, const MessageTarget& target, const CTCTags::TagMessageDetails& details)
 {
-       /* Server origin */
-       if (!user)
+       if (target.type != MessageTarget::TYPE_CHANNEL)
                return;
 
-       if (target_type != TYPE_CHANNEL)
+       Channel* channel = target.Get<Channel>();
+       djm.RevealUser(user, channel);
+}
+
+void ModuleDelayJoin::OnUserMessage(User* user, const MessageTarget& target, const MessageDetails& details)
+{
+       if (target.type != MessageTarget::TYPE_CHANNEL)
                return;
 
-       Channel* channel = (Channel*) dest;
+       Channel* channel = target.Get<Channel>();
+       djm.RevealUser(user, channel);
+}
 
-       if (!user->GetExt("delayjoin_"+channel->name))
+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) */
-       this->WriteCommonFrom(user, channel, "JOIN %s", channel->name.c_str());
-
-       std::string n = this->ServerInstance->Modes->ModeString(user, channel);
-       if (n.length() > 0)
-               this->WriteCommonFrom(user, channel, "MODE %s +%s", channel->name.c_str(), n.c_str());
-
-       /* Shrink off the neccessary metadata for a specific channel */
-       user->Shrink("delayjoin_"+channel->name);
-
-       /* 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;
-
-       user->Shrink("delayjoin");
+       CUList except_list;
+       except_list.insert(user);
+       ClientProtocol::Events::Join joinevent(memb);
+       chan->Write(joinevent, 0, except_list);
 }
 
-// .. is there a real need to duplicate WriteCommonExcept?
-void ModuleDelayJoin::WriteCommonFrom(User *user, Channel* channel, const char* text, ...)
+/* make the user visible if he receives any mode change */
+ModResult ModuleDelayJoin::OnRawMode(User* user, Channel* channel, ModeHandler* mh, const std::string& param, bool adding)
 {
-       va_list argsPtr;
-       char textbuffer[MAXBUF];
-       char tb[MAXBUF];
+       if (!channel || param.empty())
+               return MOD_RES_PASSTHRU;
 
-       va_start(argsPtr, text);
-       vsnprintf(textbuffer, MAXBUF, text, argsPtr);
-       va_end(argsPtr);
-       snprintf(tb,MAXBUF,":%s %s",user->GetFullHost().c_str(), textbuffer);
+       // If not a prefix mode then we got nothing to do here
+       if (!mh->IsPrefixMode())
+               return MOD_RES_PASSTHRU;
 
-       CUList *ulist = channel->GetUsers();
+       User* dest;
+       if (IS_LOCAL(user))
+               dest = ServerInstance->FindNickOnly(param);
+       else
+               dest = ServerInstance->FindNick(param);
 
-       for (CUList::iterator i = ulist->begin(); i != ulist->end(); i++)
-       {
-               /* User doesnt get a JOIN sent to themselves */
-               if (user == i->first)
-                       continue;
+       if (!dest)
+               return MOD_RES_PASSTHRU;
 
-               /* Users with a visibility state that hides them dont appear */
-               if (user->Visibility && !user->Visibility->VisibleTo(i->first))
-                       continue;
-
-               i->first->Write(std::string(tb));
-       }
+       djm.RevealUser(dest, channel);
+       return MOD_RES_PASSTHRU;
 }
 
 MODULE_INIT(ModuleDelayJoin)
-