src/modules/m_safelist.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
   6  *                     E-mail:
   7  *              <brain@chatspike.net>
   8  *                <Craig@chatspike.net>
   9  *
  10  * Written by Craig Edwards, Craig McLure, and others.
  11  * This program is free but copyrighted software; see
  12  *          the file COPYING for details.
  13  *
  14  * ---------------------------------------------------
  15  */
  16
  17 using namespace std;
  18
  19 #include "users.h"
  20 #include "channels.h"
  21 #include "modules.h"
  22 #include "helperfuncs.h"
  23 #include "message.h"
  24 #include <vector>
  25
  26 extern time_t TIME;
  27
  28 class ListData
  29 {
  30  public:
  31         long list_start;
  32         long list_position;
  33         bool list_ended;
  34
  35         ListData() : list_start(0), list_position(0), list_ended(false) {};
  36         ListData(long pos, time_t t) : list_start(t), list_position(pos), list_ended(false) {};
  37 };
  38
  39 /* $ModDesc: A module overriding /list, and making it safe - stop those sendq problems. */
  40
  41 typedef std::vector<userrec *> UserList;
  42 UserList listusers;    /* vector of people doing a /list */
  43
  44 /*
  45  * To create a timer which recurs every second, we inherit from InspTimer.
  46  * InspTimer is only one-shot however, so at the end of each Tick() we simply
  47  * insert another of ourselves into the pending queue :)
  48  */
  49 class ListTimer : public InspTimer
  50 {
  51  private:
  52
  53         Server* Srv;
  54         char buffer[MAXBUF];
  55         chanrec *chan;
  56
  57  public:
  58
  59         ListTimer(long interval, Server* Me) : InspTimer(interval,TIME), Srv(Me)
  60         {
  61         }
  62
  63         virtual void Tick(time_t TIME)
  64         {
  65                 bool go_again = true;
  66
  67                 while (go_again)
  68                 {
  69                         go_again = false;
  70                         for (UserList::iterator iter = listusers.begin(); iter != listusers.end(); iter++)
  71                         {
  72                                 /*
  73                                  * What we do here:
  74                                  *  - Get where they are up to
  75                                  *  - If it's > GetChannelCount, erase them from the iterator, set go_again to true
  76                                  *  - If not, spool the next 20 channels
  77                                  */
  78                                 userrec* u = (userrec*)(*iter);
  79                                 ListData* ld = (ListData*)u->GetExt("safelist_cache");
  80                                 if (ld->list_position > Srv->GetChannelCount())
  81                                 {
  82                                         u->Shrink("safelist_cache");
  83                                         delete ld;
  84                                         listusers.erase(iter);
  85                                         go_again = true;
  86                                         break;
  87                                 }
  88
  89                                 log(DEBUG, "m_safelist.so: resuming spool of list to client %s at channel %ld", u->nick, ld->list_position);
  90                                 chan = NULL;
  91                                 /* Attempt to fill up to half the user's sendq with /LIST output */
  92                                 long amount_sent = 0;
  93                                 do
  94                                 {
  95                                         log(DEBUG,"Channel %ld",ld->list_position);
  96                                         if (!ld->list_position)
  97                                                 WriteServ(u->fd,"321 %s Channel :Users Name",u->nick);
  98                                         chan = Srv->GetChannelIndex(ld->list_position);
  99                                         /* spool details */
 100                                         bool has_user = chan->HasUser(u);
 101                                         if ((chan) && (((!(chan->binarymodes & CM_PRIVATE)) && (!(chan->binarymodes & CM_SECRET))) || (has_user)))
 102                                         {
 103                                                 /* Increment total plus linefeed */
 104                                                 int counter = snprintf(buffer,MAXBUF,"322 %s %s %d :[+%s] %s",u->nick,chan->name,usercount_i(chan),chanmodes(chan,has_user),chan->topic);
 105                                                 amount_sent += counter + 4 + Srv->GetServerName().length();
 106                                                 log(DEBUG,"m_safelist.so: Sent %ld of safe %ld / 4",amount_sent,u->sendqmax);
 107                                                 WriteServ_NoFormat(u->fd,buffer);
 108                                         }
 109                                         else
 110                                         {
 111                                                 if (!chan)
 112                                                 {
 113                                                         if (!ld->list_ended)
 114                                                         {
 115                                                                 ld->list_ended = true;
 116                                                                 WriteServ(u->fd,"323 %s :End of channel list.",u->nick);
 117                                                         }
 118                                                 }
 119                                         }
 120
 121                                         ld->list_position++;
 122                                 }
 123                                 while ((chan != NULL) && (amount_sent < (u->sendqmax / 4)));
 124                         }
 125                 }
 126
 127                 ListTimer* MyTimer = new ListTimer(1,Srv);
 128                 Srv->AddTimer(MyTimer);
 129         }
 130 };
 131
 132 class ModuleSafeList : public Module
 133 {
 134  private:
 135          Server *Srv;
 136          ListTimer* MyTimer;
 137  public:
 138         ModuleSafeList(Server* Me) : Module::Module(Me)
 139         {
 140                 Srv = Me;
 141
 142                 MyTimer = new ListTimer(1,Srv);
 143                 Srv->AddTimer(MyTimer);
 144         }
 145
 146         virtual ~ModuleSafeList()
 147         {
 148         }
 149
 150         virtual Version GetVersion()
 151         {
 152                 return Version(1,0,0,0,VF_VENDOR);
 153         }
 154
 155         void Implements(char* List)
 156         {
 157                 List[I_OnPreCommand] = List[I_OnCleanup] = List[I_OnUserQuit] = List[I_On005Numeric] = 1;
 158         }
 159
 160         /*
 161          * OnPreCommand()
 162          *   Intercept the LIST command.
 163          */
 164         virtual int OnPreCommand(std::string command, char **parameters, int pcnt, userrec *user, bool validated)
 165         {
 166                 /* If the command doesnt appear to be valid, we dont want to mess with it. */
 167                 if (!validated)
 168                         return 0;
 169
 170                 if (command == "LIST")
 171                 {
 172                         return this->HandleList(parameters, pcnt, user);
 173                 }
 174                 return 0;
 175         }
 176
 177         /*
 178          * HandleList()
 179          *   Handle (override) the LIST command.
 180          */
 181         int HandleList(char** parameters, int pcnt, userrec* user)
 182         {
 183                 /* First, let's check if the user is currently /list'ing */
 184                 ListData *ld = (ListData*)user->GetExt("safelist_cache");
 185
 186                 if (ld)
 187                 {
 188                         /* user is already /list'ing, we don't want to do shit. */
 189                         return 1;
 190                 }
 191
 192                 time_t* last_list_time = (time_t*)user->GetExt("safelist_last");
 193                 if (last_list_time)
 194                 {
 195                         if (TIME < (*last_list_time)+60)
 196                         {
 197                                 WriteServ(user->fd,"NOTICE %s :*** Woah there, slow down a little, you can't /LIST so often!",user->nick);
 198                                 return 1;
 199                         }
 200
 201                         delete last_list_time;
 202                         user->Shrink("safelist_last");
 203                 }
 204
 205                 /*
 206                  * start at channel 0! ;)
 207                  */
 208                 ld = new ListData(0,TIME);
 209                 user->Extend("safelist_cache", (char*)ld);
 210                 listusers.push_back(user);
 211
 212                 time_t* llt = new time_t;
 213                 *llt = TIME;
 214                 user->Extend("safelist_last",(char*)llt);
 215
 216                 return 1;
 217         }
 218
 219         virtual void OnCleanup(int target_type, void* item)
 220         {
 221                 if(target_type == TYPE_USER)
 222                 {
 223                         userrec* u = (userrec*)item;
 224                         ListData* ld = (ListData*)u->GetExt("safelist_cache");
 225                         if (ld)
 226                         {
 227                                 u->Shrink("safelist_cache");
 228                                 delete ld;
 229                         }
 230                         for (UserList::iterator iter = listusers.begin(); iter != listusers.end(); iter++)
 231                         {
 232                                 userrec* u2 = (userrec*)(*iter);
 233                                 if (u2 == u)
 234                                 {
 235                                         listusers.erase(iter);
 236                                         break;
 237                                 }
 238                         }
 239                         time_t* last_list_time = (time_t*)u->GetExt("safelist_last");
 240                         if (last_list_time)
 241                         {
 242                                 delete last_list_time;
 243                                 u->Shrink("safelist_last");
 244                         }
 245                 }
 246         }
 247
 248         virtual void On005Numeric(std::string &output)
 249         {
 250                 output.append(" SAFELIST");
 251         }
 252
 253         virtual void OnUserQuit(userrec* user, std::string message)
 254         {
 255                 this->OnCleanup(TYPE_USER,user);
 256         }
 257
 258 };
 259
 260
 261
 262 /******************************************************************************************************/
 263
 264 class ModuleSafeListFactory : public ModuleFactory
 265 {
 266  public:
 267         ModuleSafeListFactory()
 268         {
 269         }
 270
 271         ~ModuleSafeListFactory()
 272         {
 273         }
 274
 275         virtual Module * CreateModule(Server* Me)
 276         {
 277                 return new ModuleSafeList(Me);
 278         }
 279
 280 };
 281
 282 extern "C" void * init_module( void )
 283 {
 284         return new ModuleSafeListFactory;
 285 }