]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_delayjoin.cpp
Allow commands to optionally route themselves using ENCAP
[user/henk/code/inspircd.git] / src / modules / m_delayjoin.cpp
index 6a048146556d927c6dedcd84cae964065541b7c4..8b5e83e88b5b6d3e82ced1e3929aec1ec0165857 100644 (file)
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
  *
  * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ *         the file COPYING for details.
  *
  * ---------------------------------------------------
  */
 
 #include "inspircd.h"
-
-/* $ModDesc: Allows for delay-join channels (+D) where users dont appear to join until they speak */
+#include <stdarg.h>
 
 class DelayJoinMode : public ModeHandler
 {
+ private:
+       CUList empty;
+       Module* Creator;
  public:
-       DelayJoinMode(InspIRCd* Instance) : ModeHandler(Instance, 'D', 0, 0, false, MODETYPE_CHANNEL, false) { }
+       DelayJoinMode(InspIRCd* Instance, Module* Parent) : ModeHandler(Instance, 'D', 0, 0, false, MODETYPE_CHANNEL, false, 0, '@'), Creator(Parent) {};
 
-       ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding)
-       {
-               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
-                       {
-                               channel->SetMode('D', adding);
-                               return MODEACTION_ALLOW;
-                       }
-               }
-               else
-               {
-                       return MODEACTION_DENY;
-               }
-       }
+       ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, bool);
 };
 
 class ModuleDelayJoin : public Module
 {
  private:
-       DelayJoinMode* djm;
+       DelayJoinMode djm;
        CUList nl;
-       CUList except_list;
  public:
-       ModuleDelayJoin(InspIRCd* Me)
-               : Module(Me)
+       ModuleDelayJoin(InspIRCd* Me) : Module(Me), djm(Me, this)
        {
-               djm = new DelayJoinMode(ServerInstance);
-               if (!ServerInstance->AddMode(djm))
+               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);
        }
-       
-       virtual ~ModuleDelayJoin()
-       {
-               ServerInstance->Modes->DelMode(djm);
-               DELETE(djm);
-       }
+       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 created);
+       void CleanUser(User* user);
+       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);
+};
 
-       Priority Prioritize()
-       {
-               /* To ensure that we get priority over namesx for names list generation on +u channels */
-               return (Priority)ServerInstance->Modules->PriorityBefore("m_namesx.so");
-       }
+/* $ModDesc: Allows for delay-join channels (+D) where users dont appear to join until they speak */
 
-       virtual Version GetVersion()
-       {
-               return Version(1, 1, 0, 0, VF_COMMON | VF_VENDOR, API_VERSION);
-       }
+ModeAction DelayJoinMode::OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, bool)
+{
+       /* no change */
+       if (channel->IsModeSet('D') == adding)
+               return MODEACTION_DENY;
 
-       void Implements(char* List)
+       if (!adding)
        {
-               List[I_OnUserJoin] = List[I_OnUserPart] = List[I_OnUserKick] = List[I_OnUserQuit] = List[I_OnUserList] = 
-               List[I_OnUserPreMessage] = List[I_OnUserPreNotice] = 1;
+               /*
+                * 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;
+}
+
+ModuleDelayJoin::~ModuleDelayJoin()
+{
+       ServerInstance->Modes->DelMode(&djm);
+}
+
+Version ModuleDelayJoin::GetVersion()
+{
+       return Version("$Id$", VF_COMMON | VF_VENDOR, API_VERSION);
+}
+
+void ModuleDelayJoin::OnNamesListItem(User* issuer, User* user, Channel* channel, std::string &prefixes, std::string &nick)
+{
+       if (!channel->IsModeSet('D'))
+               return;
 
-       virtual int OnUserList(User* user, Channel* Ptr, CUList* &nameslist)
+       if (nick.empty())
+               return;
+
+       /* don't prevent the user from seeing themself */
+       if (issuer == user)
+               return;
+
+       /* If the user is hidden by delayed join, hide them from the NAMES list */
+       if (user->GetExt("delayjoin_"+channel->name))
+               nick.clear();
+}
+
+void ModuleDelayJoin::OnUserJoin(User* user, Channel* channel, bool sync, bool &silent, bool created)
+{
+       if (channel->IsModeSet('D'))
        {
-               if (Ptr->IsModeSet('D'))
-               {
-                       nl = *nameslist;
+               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());
 
-                       for (CUListIter n = nameslist->begin(); n != nameslist->end(); ++n)
-                       {
-                               if (n->first->GetExt("delayjoin_notspoken"))
-                                       nl.erase(n->first);
-                       }
+               /* This metadata tells the module the user is delayed join on this specific channel */
+               user->Extend("delayjoin_"+channel->name);
 
-                       nl[user] = user->nick;
-                       nameslist = &nl;
-               }
-               return 0;
+               /* 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");
        }
-       
-       virtual void OnUserJoin(User* user, Channel* channel, bool &silent)
+}
+
+void ModuleDelayJoin::CleanUser(User* user)
+{
+       /* Check if the user is hidden on any other +D channels, if so don't take away the
+        * metadata that says they're hidden on one or more channels
+        */
+       for (UCListIter f = user->chans.begin(); f != user->chans.end(); f++)
+               if (user->GetExt("delayjoin_" + f->first->name))
+                       return;
+
+       user->Shrink("delayjoin");
+}
+
+void ModuleDelayJoin::OnUserPart(User* user, Channel* channel, std::string &partmessage, bool &silent)
+{
+       if (!channel->IsModeSet('D'))
+               return;
+       if (user->GetExt("delayjoin_"+channel->name))
        {
-               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);
-                       user->Extend(std::string("delayjoin_")+channel->name);
-                       user->Extend("delayjoin");
-               }
+               user->Shrink("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());
+               CleanUser(user);
        }
+}
 
-       void OnUserPart(User* user, Channel* channel, const std::string &partmessage, bool &silent)
+void ModuleDelayJoin::OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent)
+{
+       if (!chan->IsModeSet('D'))
+               return;
+       /* Send silenced event only to the user being kicked and the user doing the kick */
+       if (user->GetExt("delayjoin_"+chan->name))
        {
-               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());
-                       }
-               }
+               user->Shrink("delayjoin_"+chan->name);
+               silent = true;
+               user->WriteFrom(source, "KICK %s %s %s", chan->name.c_str(), user->nick.c_str(), reason.c_str());
+               CleanUser(user);
        }
+}
+
+bool ModuleDelayJoin::OnHostCycle(User* user)
+{
+       return user->GetExt("delayjoin");
+}
 
-       void OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent)
+void ModuleDelayJoin::OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
+{
+       Command* parthandler = ServerInstance->Parser->GetHandler("PART");
+       if (parthandler && user->GetExt("delayjoin"))
        {
-               if (chan->IsModeSet('D'))
+               for (UCListIter f = user->chans.begin(); f != user->chans.end(); f++)
                {
-                       /* Send silenced event only to the user being kicked and the user doing the kick */
-                       if (user->GetExt(std::string("delayjoin_")+chan->name))
+                       Channel* chan = f->first;
+                       if (user->GetExt("delayjoin_"+chan->name))
                        {
-                               silent = true;
-                               user->WriteFrom(source, "KICK %s %s %s", chan->name, user->nick, reason.c_str());
+                               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);
                        }
                }
+               user->Shrink("delayjoin");
        }
+}
+
+void ModuleDelayJoin::OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list)
+{
+       /* Server origin */
+       if (!user)
+               return;
+
+       if (target_type != TYPE_CHANNEL)
+               return;
 
-       void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
+       Channel* channel = (Channel*) dest;
+
+       if (!user->GetExt("delayjoin_"+channel->name))
+               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);
+       CleanUser(user);
+}
+
+// .. is there a real need to duplicate WriteCommonExcept?
+void ModuleDelayJoin::WriteCommonFrom(User *user, Channel* channel, const char* text, ...)
+{
+       va_list argsPtr;
+       char textbuffer[MAXBUF];
+       char tb[MAXBUF];
+
+       va_start(argsPtr, text);
+       vsnprintf(textbuffer, MAXBUF, text, argsPtr);
+       va_end(argsPtr);
+       snprintf(tb,MAXBUF,":%s %s",user->GetFullHost().c_str(), textbuffer);
+
+       CUList *ulist = channel->GetUsers();
+
+       for (CUList::iterator i = ulist->begin(); i != ulist->end(); i++)
        {
-               Command* parthandler = ServerInstance->Parser->GetHandler("PART");
-               std::vector<std::string> to_leave;
-               const char* parameters[2];
-               if (parthandler && user->GetExt("delayjoin"))
-               {
-                       for (UCListIter f = user->chans.begin(); f != user->chans.end(); f++)
-                       {
-                               if (f->first->IsModeSet('D'))
-                                       to_leave.push_back(f->first->name);
-                       }
-                       /* We cant do this neatly in one loop, as we are modifying the map we are iterating */
-                       for (std::vector<std::string>::iterator n = to_leave.begin(); n != to_leave.end(); n++)
-                       {
-                               parameters[0] = n->c_str();
-                               /* This triggers our OnUserPart, above, making the PART silent */
-                               parthandler->Handle(parameters, 1, user);
-                       }
-               }
+               /* User doesnt get a JOIN sent to themselves */
+               if (user == i->first)
+                       continue;
+
+               /* 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));
        }
-};
+}
 
 MODULE_INIT(ModuleDelayJoin)