src/modules/m_delayjoin.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *          the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #include "inspircd.h"
  15 #include <stdarg.h>
  16
  17 /* $ModDesc: Allows for delay-join channels (+D) where users dont appear to join until they speak */
  18
  19 class DelayJoinMode : public ModeHandler
  20 {
  21         CUList empty;
  22         Module* Creator;
  23  public:
  24         DelayJoinMode(InspIRCd* Instance, Module* Parent) : ModeHandler(Instance, 'D', 0, 0, false, MODETYPE_CHANNEL, false), Creator(Parent) { }
  25
  26         ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, bool)
  27         {
  28                 if (channel->IsModeSet('D') != adding)
  29                 {
  30                         if (IS_LOCAL(source) && (channel->GetStatus(source) < STATUS_OP))
  31                         {
  32                                 source->WriteServ("482 %s %s :Only channel operators may %sset channel mode +D", source->nick, channel->name, adding ? "" : "un");
  33                                 return MODEACTION_DENY;
  34                         }
  35                         else
  36                         {
  37                                 if (channel->IsModeSet('D'))
  38                                 {
  39                                         /* Make all delayed join users visible, or if an op removes +D
  40                                          * while users exist that havent spoken, they remain permenantly
  41                                          * invisible on this channel!
  42                                          */
  43                                         CUList* names = channel->GetUsers();
  44                                         for (CUListIter n = names->begin(); n != names->end(); ++n)
  45                                                 Creator->OnText(n->first, channel, TYPE_CHANNEL, "", 0, empty);
  46                                 }
  47                                 channel->SetMode('D', adding);
  48                                 return MODEACTION_ALLOW;
  49                         }
  50                 }
  51                 else
  52                 {
  53                         return MODEACTION_DENY;
  54                 }
  55         }
  56 };
  57
  58 class ModuleDelayJoin : public Module
  59 {
  60  private:
  61         DelayJoinMode* djm;
  62         CUList nl;
  63  public:
  64         ModuleDelayJoin(InspIRCd* Me)
  65                 : Module(Me)
  66         {
  67                 djm = new DelayJoinMode(ServerInstance, this);
  68                 if (!ServerInstance->Modes->AddMode(djm))
  69                         throw ModuleException("Could not add new modes!");
  70                 Implementation eventlist[] = { I_OnUserJoin, I_OnUserPart, I_OnUserKick, I_OnUserQuit, I_OnUserList, I_OnText };
  71                 ServerInstance->Modules->Attach(eventlist, this, 6);
  72         }
  73
  74         virtual ~ModuleDelayJoin()
  75         {
  76                 ServerInstance->Modes->DelMode(djm);
  77                 delete djm;
  78         }
  79
  80         void Prioritize()
  81         {
  82                 /* To ensure that we get priority over namesx for names list generation */
  83                 Module* namesx = ServerInstance->Modules->Find("m_namesx.so");
  84                 ServerInstance->Modules->SetPriority(this, I_OnUserList, PRIO_BEFORE, &namesx);
  85         }
  86
  87         virtual Version GetVersion()
  88         {
  89                 return Version(1, 1, 0, 0, VF_COMMON | VF_VENDOR, API_VERSION);
  90         }
  91
  92
  93         virtual int OnUserList(User* user, Channel* Ptr, CUList* &nameslist)
  94         {
  95                 CUList* newlist = nameslist ? nameslist : Ptr->GetUsers();
  96
  97                 nl.clear();
  98
  99                 /* For +D channels ... */
 100                 if (Ptr->IsModeSet('D'))
 101                 {
 102                         std::string key("delayjoin_");
 103                         key.append(Ptr->name);
 104
 105                         /* Modify the names list, erasing users with the delay join metadata
 106                          * for this channel (havent spoken yet)
 107                          */
 108                         for (CUListIter n = newlist->begin(); n != newlist->end(); ++n)
 109                         {
 110                                 if (!n->first->GetExt(key))
 111                                         nl.insert(*n);
 112                         }
 113
 114                         /* Always show self */
 115                         nl[user] = user->nick;
 116                         nameslist = &nl;
 117                 }
 118                 return 0;
 119         }
 120
 121         virtual void OnUserJoin(User* user, Channel* channel, bool sync, bool &silent)
 122         {
 123                 if (channel->IsModeSet('D'))
 124                 {
 125                         silent = true;
 126                         /* Because we silenced the event, make sure it reaches the user whos joining (but only them of course) */
 127                         user->WriteFrom(user, "JOIN %s", channel->name);
 128
 129                         /* This metadata tells the module the user is delayed join on this specific channel */
 130                         user->Extend(std::string("delayjoin_")+channel->name);
 131
 132                         /* This metadata tells the module the user is delayed join on at least one (or more) channels.
 133                          * It is only cleared when the user is no longer on ANY +D channels.
 134                          */
 135                         if (!user->GetExt("delayjoin"))
 136                                 user->Extend("delayjoin");
 137                 }
 138         }
 139
 140         void OnUserPart(User* user, Channel* channel, const std::string &partmessage, bool &silent)
 141         {
 142                 if (channel->IsModeSet('D'))
 143                 {
 144                         if (user->GetExt(std::string("delayjoin_")+channel->name))
 145                         {
 146                                 silent = true;
 147                                 /* Because we silenced the event, make sure it reaches the user whos leaving (but only them of course) */
 148                                 user->WriteFrom(user, "PART %s%s%s", channel->name, partmessage.empty() ? "" : " :", partmessage.empty() ? "" : partmessage.c_str());
 149                         }
 150                 }
 151         }
 152
 153         void OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent)
 154         {
 155                 if (chan->IsModeSet('D'))
 156                 {
 157                         /* Send silenced event only to the user being kicked and the user doing the kick */
 158                         if (user->GetExt(std::string("delayjoin_")+chan->name))
 159                         {
 160                                 silent = true;
 161                                 user->WriteFrom(source, "KICK %s %s %s", chan->name, user->nick, reason.c_str());
 162                         }
 163                 }
 164         }
 165
 166         void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
 167         {
 168                 Command* parthandler = ServerInstance->Parser->GetHandler("PART");
 169                 const char* parameters[2];
 170                 if (parthandler && user->GetExt("delayjoin"))
 171                 {
 172                         for (UCListIter f = user->chans.begin(); f != user->chans.end(); f++)
 173                         {
 174                                 parameters[0] = f->first->name;
 175                                 /* This triggers our OnUserPart, above, making the PART silent */
 176                                 parthandler->Handle(parameters, 1, user);
 177                         }
 178                 }
 179         }
 180
 181         void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list)
 182         {
 183                 if (target_type != TYPE_CHANNEL)
 184                         return;
 185
 186                 Channel* channel = (Channel*) dest;
 187
 188                 if (!user->GetExt(std::string("delayjoin_")+channel->name))
 189                         return;
 190
 191                 /* Display the join to everyone else (the user who joined got it earlier) */
 192                 this->WriteCommonFrom(user, channel, "JOIN %s", channel->name);
 193
 194                 std::string n = this->ServerInstance->Modes->ModeString(user, channel);
 195                 if (n.length() > 0)
 196                         this->WriteCommonFrom(user, channel, "MODE %s +%s", channel->name, n.c_str());
 197
 198                 /* Shrink off the neccessary metadata for a specific channel */
 199                 user->Shrink(std::string("delayjoin_")+channel->name);
 200
 201                 /* Check if the user is left on any other +D channels, if so don't take away the
 202                  * metadata that says theyre on one or more channels
 203                  */
 204                 for (UCListIter f = user->chans.begin(); f != user->chans.end(); f++)
 205                         if (f->first->IsModeSet('D'))
 206                                 return;
 207
 208                 user->Shrink("delayjoin");
 209         }
 210
 211         void WriteCommonFrom(User *user, Channel* channel, const char* text, ...)
 212         {
 213                 va_list argsPtr;
 214                 char textbuffer[MAXBUF];
 215                 char tb[MAXBUF];
 216
 217                 va_start(argsPtr, text);
 218                 vsnprintf(textbuffer, MAXBUF, text, argsPtr);
 219                 va_end(argsPtr);
 220                 snprintf(tb,MAXBUF,":%s %s",user->GetFullHost(),textbuffer);
 221
 222                 CUList *ulist = channel->GetUsers();
 223
 224                 for (CUList::iterator i = ulist->begin(); i != ulist->end(); i++)
 225                 {
 226                         /* User doesnt get a JOIN sent to themselves */
 227                         if (user == i->first)
 228                                 continue;
 229
 230                         /* Users with a visibility state that hides them dont appear */
 231                         if (user->Visibility && !user->Visibility->VisibleTo(i->first))
 232                                 continue;
 233
 234                         i->first->Write(std::string(tb));
 235                 }
 236         }
 237
 238 };
 239
 240 MODULE_INIT(ModuleDelayJoin)
 241