src/modules/m_delayjoin.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2007 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
  16 /* $ModDesc: Allows for delay-join channels (+D) where users dont appear to join until they speak */
  17
  18 class DelayJoinMode : public ModeHandler
  19 {
  20  public:
  21         DelayJoinMode(InspIRCd* Instance) : ModeHandler(Instance, 'D', 0, 0, false, MODETYPE_CHANNEL, false) { }
  22
  23         ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding)
  24         {
  25                 if (channel->IsModeSet('D') != adding)
  26                 {
  27                         if (IS_LOCAL(source) && (channel->GetStatus(source) < STATUS_OP))
  28                         {
  29                                 source->WriteServ("482 %s %s :Only channel operators may %sset channel mode +D", source->nick, channel->name, adding ? "" : "un");
  30                                 return MODEACTION_DENY;
  31                         }
  32                         else
  33                         {
  34                                 channel->SetMode('D', adding);
  35                                 return MODEACTION_ALLOW;
  36                         }
  37                 }
  38                 else
  39                 {
  40                         return MODEACTION_DENY;
  41                 }
  42         }
  43 };
  44
  45 class ModuleDelayJoin : public Module
  46 {
  47  private:
  48         DelayJoinMode* djm;
  49         CUList nl;
  50  public:
  51         ModuleDelayJoin(InspIRCd* Me)
  52                 : Module(Me)
  53         {
  54                 djm = new DelayJoinMode(ServerInstance);
  55                 if (!ServerInstance->AddMode(djm))
  56                         throw ModuleException("Could not add new modes!");
  57         }
  58
  59         virtual ~ModuleDelayJoin()
  60         {
  61                 ServerInstance->Modes->DelMode(djm);
  62                 DELETE(djm);
  63         }
  64
  65         Priority Prioritize()
  66         {
  67                 /* To ensure that we get priority over namesx for names list generation on +u channels */
  68                 return (Priority)ServerInstance->Modules->PriorityBefore("m_namesx.so");
  69         }
  70
  71         virtual Version GetVersion()
  72         {
  73                 return Version(1, 1, 0, 0, VF_COMMON | VF_VENDOR, API_VERSION);
  74         }
  75
  76         void Implements(char* List)
  77         {
  78                 List[I_OnUserJoin] = List[I_OnUserPart] = List[I_OnUserKick] = List[I_OnUserQuit] = List[I_OnUserList] = List[I_OnText] = 1;
  79         }
  80
  81         virtual int OnUserList(User* user, Channel* Ptr, CUList* &nameslist)
  82         {
  83                 CUList* newlist = nameslist ? nameslist : Ptr->GetUsers();
  84
  85                 nl.clear();
  86
  87                 /* For +D channels ... */
  88                 if (Ptr->IsModeSet('D'))
  89                 {
  90                         std::string key("delayjoin_");
  91                         key.append(Ptr->name);
  92
  93                         /* Modify the names list, erasing users with the delay join metadata
  94                          * for this channel (havent spoken yet)
  95                          */
  96                         for (CUListIter n = newlist->begin(); n != newlist->end(); ++n)
  97                         {
  98                                 if (!n->first->GetExt(key))
  99                                         nl.insert(*n);
 100                         }
 101
 102                         /* Always show self */
 103                         nl[user] = user->nick;
 104                         nameslist = &nl;
 105                 }
 106                 return 0;
 107         }
 108
 109         virtual void OnUserJoin(User* user, Channel* channel, bool &silent)
 110         {
 111                 if (channel->IsModeSet('D'))
 112                 {
 113                         silent = true;
 114                         /* Because we silenced the event, make sure it reaches the user whos joining (but only them of course) */
 115                         user->WriteFrom(user, "JOIN %s", channel->name);
 116
 117                         /* This metadata tells the module the user is delayed join on this specific channel */
 118                         user->Extend(std::string("delayjoin_")+channel->name);
 119
 120                         /* This metadata tells the module the user is delayed join on at least one (or more) channels.
 121                          * It is only cleared when the user is no longer on ANY +D channels.
 122                          */
 123                         if (!user->GetExt("delayjoin"))
 124                                 user->Extend("delayjoin");
 125                 }
 126         }
 127
 128         void OnUserPart(User* user, Channel* channel, const std::string &partmessage, bool &silent)
 129         {
 130                 if (channel->IsModeSet('D'))
 131                 {
 132                         if (user->GetExt(std::string("delayjoin_")+channel->name))
 133                         {
 134                                 silent = true;
 135                                 /* Because we silenced the event, make sure it reaches the user whos leaving (but only them of course) */
 136                                 user->WriteFrom(user, "PART %s%s%s", channel->name, partmessage.empty() ? "" : " :", partmessage.empty() ? "" : partmessage.c_str());
 137                         }
 138                 }
 139         }
 140
 141         void OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent)
 142         {
 143                 if (chan->IsModeSet('D'))
 144                 {
 145                         /* Send silenced event only to the user being kicked and the user doing the kick */
 146                         if (user->GetExt(std::string("delayjoin_")+chan->name))
 147                         {
 148                                 silent = true;
 149                                 user->WriteFrom(source, "KICK %s %s %s", chan->name, user->nick, reason.c_str());
 150                         }
 151                 }
 152         }
 153
 154         void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
 155         {
 156                 Command* parthandler = ServerInstance->Parser->GetHandler("PART");
 157                 const char* parameters[2];
 158                 if (parthandler && user->GetExt("delayjoin"))
 159                 {
 160                         for (UCListIter f = user->chans.begin(); f != user->chans.end(); f++)
 161                         {
 162                                 parameters[0] = f->first->name;
 163                                 /* This triggers our OnUserPart, above, making the PART silent */
 164                                 parthandler->Handle(parameters, 1, user);
 165                         }
 166                 }
 167         }
 168
 169         void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list)
 170         {
 171                 if (target_type != TYPE_CHANNEL)
 172                         return;
 173
 174                 Channel* channel = (Channel*) dest;
 175
 176                 if (!user->GetExt(std::string("delayjoin_")+channel->name))
 177                         return;
 178
 179                 /* Display the join to everyone else (the user who joined got it earlier) */
 180                 channel->WriteAllExcept(user, false, 0, exempt_list, "JOIN %s", channel->name);
 181
 182                 /* Shrink off the neccessary metadata for a specific channel */
 183                 user->Shrink(std::string("delayjoin_")+channel->name);
 184
 185                 /* Check if the user is left on any other +D channels, if so don't take away the
 186                  * metadata that says theyre on one or more channels
 187                  */
 188                 for (UCListIter f = user->chans.begin(); f != user->chans.end(); f++)
 189                         if (f->first->IsModeSet('D'))
 190                                 return;
 191
 192                 user->Shrink("delayjoin");
 193         }
 194 };
 195
 196 MODULE_INIT(ModuleDelayJoin)
 197