]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_delayjoin.cpp
Sync helpop chmodes s and p with docs
[user/henk/code/inspircd.git] / src / modules / m_delayjoin.cpp
index f182e18d0f4c74e7b3d1db521ce78a39ec464b2e..d58f07c2be5fd1f80ef43d19fe99688bdcce3a02 100644 (file)
-/*       +------------------------------------+
- *       | 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) 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>
+#include "modules/ctctags.h"
+#include "modules/ircv3_servertime.h"
+#include "modules/names.h"
+#include "modules/who.h"
 
 class DelayJoinMode : public ModeHandler
 {
  private:
-       CUList empty;
+       LocalIntExt& unjoined;
+       IRCv3::ServerTime::API servertime;
+
  public:
-       DelayJoinMode(InspIRCd* Instance, Module* Parent) : ModeHandler(Instance, Parent, 'D', 0, 0, false, MODETYPE_CHANNEL, false, 0, '@') {};
+       DelayJoinMode(Module* Parent, LocalIntExt& ext)
+               : ModeHandler(Parent, "delayjoin", 'D', PARAM_NONE, MODETYPE_CHANNEL)
+               , unjoined(ext)
+               , servertime(Parent)
+       {
+               ranktoset = ranktounset = OP_VALUE;
+       }
 
-       ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding);
+       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
+{
+
+/** 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
+{
+ private:
+       const LocalIntExt& unjoined;
+
+ public:
+       JoinHook(Module* mod, const LocalIntExt& unjoinedref)
+               : ClientProtocol::EventHook(mod, "JOIN", 10)
+               , unjoined(unjoinedref)
+       {
+       }
+
+       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;
+       }
+};
+
+}
+
+class ModuleDelayJoin
+       : public Module
+       , public CTCTags::EventListener
+       , public Names::EventListener
+       , public Who::EventListener
 {
-       DelayJoinMode djm;
  public:
        LocalIntExt unjoined;
-       ModuleDelayJoin(InspIRCd* Me) : Module(Me), djm(Me, this), unjoined("delayjoin", this)
+       JoinHook joinhook;
+       DelayJoinMode djm;
+
+       ModuleDelayJoin()
+               : CTCTags::EventListener(this)
+               , Names::EventListener(this)
+               , Who::EventListener(this)
+               , unjoined("delayjoin", ExtensionItem::EXT_MEMBERSHIP, this)
+               , joinhook(this, unjoined)
+               , djm(this, unjoined)
        {
-               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, I_OnHostCycle };
-               ServerInstance->Modules->Attach(eventlist, this, 7);
        }
-       ~ModuleDelayJoin();
-       Version GetVersion();
-       void OnNamesListItem(User* issuer, Membership*, std::string &prefixes, std::string &nick);
-       void OnUserJoin(Membership*, bool, bool, CUList&);
+
+       Version GetVersion() CXX11_OVERRIDE;
+       ModResult OnNamesListItem(LocalUser* issuer, Membership*, std::string& prefixes, std::string& nick) CXX11_OVERRIDE;
+       ModResult OnWhoLine(const Who::Request& request, LocalUser* source, User* user, Membership* memb, Numeric::Numeric& numeric) CXX11_OVERRIDE;
+       void OnUserJoin(Membership*, bool, bool, CUList&) CXX11_OVERRIDE;
        void CleanUser(User* user);
-       ModResult OnHostCycle(User* user);
-       void OnUserPart(Membership*, std::string &partmessage, CUList&);
-       void OnUserKick(User* source, Membership*, const std::string &reason, CUList&);
-       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 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;
 };
 
-/* $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)
 {
        /* no change */
-       if (channel->IsModeSet('D') == adding)
+       if (channel->IsModeSet(this) == adding)
                return MODEACTION_DENY;
 
        if (!adding)
@@ -62,39 +129,53 @@ ModeAction DelayJoinMode::OnModeChange(User* source, User* dest, Channel* channe
                 * Make all users visible, as +D is being removed. If we don't do this,
                 * they remain permanently invisible on this channel!
                 */
-               const UserMembList* names = channel->GetUsers();
-               for (UserMembCIter n = names->begin(); n != names->end(); ++n)
-                       creator->OnText(n->first, channel, TYPE_CHANNEL, "", 0, empty);
+               const Channel::MemberMap& users = channel->GetUsers();
+               for (Channel::MemberMap::const_iterator n = users.begin(); n != users.end(); ++n)
+                       RevealUser(n->first, channel);
        }
-       channel->SetMode('D', adding);
+       channel->SetMode(this, adding);
        return MODEACTION_ALLOW;
 }
 
-ModuleDelayJoin::~ModuleDelayJoin()
-{
-       ServerInstance->Modes->DelMode(&djm);
-}
-
 Version ModuleDelayJoin::GetVersion()
 {
-       return Version("$Id$", VF_COMMON | VF_VENDOR);
+       return Version("Adds channel mode D (delayjoin) which hides JOIN messages from users until they speak.", VF_VENDOR);
 }
 
-void ModuleDelayJoin::OnNamesListItem(User* issuer, Membership* memb, std::string &prefixes, std::string &nick)
+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;
+               return MOD_RES_PASSTHRU;
 
        /* If the user is hidden by delayed join, hide them from the NAMES list */
        if (unjoined.get(memb))
-               nick.clear();
+               return MOD_RES_DENY;
+
+       return MOD_RES_PASSTHRU;
+}
+
+ModResult ModuleDelayJoin::OnWhoLine(const Who::Request& request, LocalUser* source, User* user, Membership* memb, Numeric::Numeric& numeric)
+{
+       // We don't need to do anything if they're not delayjoined.
+       if (!memb || !unjoined.get(memb))
+               return MOD_RES_PASSTHRU;
+
+       // Only show delayjoined users if the d flag has been specified.
+       if (!request.flags['d'])
+               return MOD_RES_DENY;
+
+       // Add the < flag to mark the user as delayjoined.
+       size_t flag_index;
+       if (request.GetFieldIndex('f', flag_index))
+               numeric.GetParams()[flag_index].push_back('<');
+       return MOD_RES_PASSTHRU;
 }
 
 static void populate(CUList& except, Membership* memb)
 {
-       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;
@@ -104,11 +185,8 @@ static void populate(CUList& except, Membership* memb)
 
 void ModuleDelayJoin::OnUserJoin(Membership* memb, bool sync, bool created, CUList& except)
 {
-       if (memb->chan->IsModeSet('D'))
-       {
-               unjoined.set(memb, 1);
-               populate(except, memb);
-       }
+       if (memb->chan->IsModeSet(djm))
+               unjoined.set(memb, ServerInstance->Time());
 }
 
 void ModuleDelayJoin::OnUserPart(Membership* memb, std::string &partmessage, CUList& except)
@@ -123,53 +201,76 @@ void ModuleDelayJoin::OnUserKick(User* source, Membership* memb, const std::stri
                populate(except, memb);
 }
 
-ModResult ModuleDelayJoin::OnHostCycle(User* user)
+void ModuleDelayJoin::OnBuildNeighborList(User* source, IncludeChanList& include, std::map<User*, bool>& exception)
 {
-       // TODO
-       return MOD_RES_DENY;
+       for (IncludeChanList::iterator i = include.begin(); i != include.end(); )
+       {
+               Membership* memb = *i;
+               if (unjoined.get(memb))
+                       i = include.erase(i);
+               else
+                       ++i;
+       }
 }
 
-void ModuleDelayJoin::OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
+void ModuleDelayJoin::OnUserTagMessage(User* user, const MessageTarget& target, const CTCTags::TagMessageDetails& details)
 {
-       Command* parthandler = ServerInstance->Parser->GetHandler("PART");
-       if (!parthandler)
+       if (target.type != MessageTarget::TYPE_CHANNEL)
                return;
-       for (UCListIter f = user->chans.begin(); f != user->chans.end(); f++)
-       {
-               Channel* chan = *f;
-               Membership* memb = chan->GetUser(user);
-               if (memb && unjoined.get(memb))
-               {
-                       std::vector<std::string> parameters;
-                       parameters.push_back(chan->name);
-                       /* Send a fake PART from the channel, which will be silent */
-                       parthandler->Handle(parameters, user);
-               }
-       }
+
+       Channel* channel = target.Get<Channel>();
+       djm.RevealUser(user, channel);
 }
 
-void ModuleDelayJoin::OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list)
+void ModuleDelayJoin::OnUserMessage(User* user, const MessageTarget& target, const MessageDetails& details)
 {
-       /* Server origin */
-       if (!user)
+       if (target.type != MessageTarget::TYPE_CHANNEL)
                return;
 
-       if (target_type != TYPE_CHANNEL)
-               return;
+       Channel* channel = target.Get<Channel>();
+       djm.RevealUser(user, channel);
+}
 
-       Channel* channel = (Channel*) dest;
+void DelayJoinMode::RevealUser(User* user, Channel* chan)
+{
+       Membership* memb = chan->GetUser(user);
+       if (!memb)
+               return;
 
-       Membership* memb = channel->GetUser(user);
-       if (!memb || !unjoined.set(memb, 0))
+       time_t jointime = unjoined.set(memb, 0);
+       if (!jointime)
                return;
 
        /* Display the join to everyone else (the user who joined got it earlier) */
-       channel->WriteAllExceptSender(user, false, 0, "JOIN %s", channel->name.c_str());
+       CUList except_list;
+       except_list.insert(user);
+       ClientProtocol::Events::Join joinevent(memb);
+       if (servertime)
+               servertime->Set(joinevent, jointime);
+       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;
+
+       // If not a prefix mode then we got nothing to do here
+       if (!mh->IsPrefixMode())
+               return MOD_RES_PASSTHRU;
 
-       std::string n = this->ServerInstance->Modes->ModeString(user, channel);
-       if (n.length() > 0)
-               channel->WriteAllExceptSender(user, false, 0, "MODE %s +%s", channel->name.c_str(), n.c_str());
+       User* dest;
+       if (IS_LOCAL(user))
+               dest = ServerInstance->FindNickOnly(param);
+       else
+               dest = ServerInstance->FindNick(param);
+
+       if (!dest)
+               return MOD_RES_PASSTHRU;
+
+       djm.RevealUser(dest, channel);
+       return MOD_RES_PASSTHRU;
 }
 
 MODULE_INIT(ModuleDelayJoin)
-