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