1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
22 #include "helperfuncs.h"
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) {};
39 /* $ModDesc: A module overriding /list, and making it safe - stop those sendq problems. */
41 typedef std::vector<userrec *> UserList;
42 UserList listusers; /* vector of people doing a /list */
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 :)
49 class ListTimer : public InspTimer
59 ListTimer(long interval, Server* Me) : InspTimer(interval,TIME), Srv(Me)
63 virtual void Tick(time_t TIME)
70 for (UserList::iterator iter = listusers.begin(); iter != listusers.end(); iter++)
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
78 userrec* u = (userrec*)(*iter);
79 ListData* ld = (ListData*)u->GetExt("safelist_cache");
80 if (ld->list_position > Srv->GetChannelCount())
82 u->Shrink("safelist_cache");
84 listusers.erase(iter);
89 log(DEBUG, "m_safelist.so: resuming spool of list to client %s at channel %ld", u->nick, ld->list_position);
91 /* Attempt to fill up to half the user's sendq with /LIST output */
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);
100 bool has_user = (u && chan->HasUser(u));
101 if ((chan) && (((!(chan->binarymodes & CM_PRIVATE)) && (!(chan->binarymodes & CM_SECRET))) || (has_user)))
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);
115 ld->list_ended = true;
116 WriteServ(u->fd,"323 %s :End of channel list.",u->nick);
123 while ((chan != NULL) && (amount_sent < (u->sendqmax / 4)));
127 ListTimer* MyTimer = new ListTimer(1,Srv);
128 Srv->AddTimer(MyTimer);
132 class ModuleSafeList : public Module
138 ModuleSafeList(Server* Me) : Module::Module(Me)
142 MyTimer = new ListTimer(1,Srv);
143 Srv->AddTimer(MyTimer);
146 virtual ~ModuleSafeList()
150 virtual Version GetVersion()
152 return Version(1,0,0,0,VF_VENDOR);
155 void Implements(char* List)
157 List[I_OnPreCommand] = List[I_OnCleanup] = List[I_OnUserQuit] = List[I_On005Numeric] = 1;
162 * Intercept the LIST command.
164 virtual int OnPreCommand(std::string command, char **parameters, int pcnt, userrec *user, bool validated)
166 /* If the command doesnt appear to be valid, we dont want to mess with it. */
170 if (command == "LIST")
172 return this->HandleList(parameters, pcnt, user);
179 * Handle (override) the LIST command.
181 int HandleList(char** parameters, int pcnt, userrec* user)
183 /* First, let's check if the user is currently /list'ing */
184 ListData *ld = (ListData*)user->GetExt("safelist_cache");
188 /* user is already /list'ing, we don't want to do shit. */
192 time_t* last_list_time = (time_t*)user->GetExt("safelist_last");
195 if (TIME < (*last_list_time)+60)
197 WriteServ(user->fd,"NOTICE %s :*** Woah there, slow down a little, you can't /LIST so often!",user->nick);
201 delete last_list_time;
202 user->Shrink("safelist_last");
206 * start at channel 0! ;)
208 ld = new ListData(0,TIME);
209 user->Extend("safelist_cache", (char*)ld);
210 listusers.push_back(user);
212 time_t* llt = new time_t;
214 user->Extend("safelist_last",(char*)llt);
219 virtual void OnCleanup(int target_type, void* item)
221 if(target_type == TYPE_USER)
223 userrec* u = (userrec*)item;
224 ListData* ld = (ListData*)u->GetExt("safelist_cache");
227 u->Shrink("safelist_cache");
230 for (UserList::iterator iter = listusers.begin(); iter != listusers.end(); iter++)
232 userrec* u2 = (userrec*)(*iter);
235 listusers.erase(iter);
239 time_t* last_list_time = (time_t*)u->GetExt("safelist_last");
242 delete last_list_time;
243 u->Shrink("safelist_last");
248 virtual void On005Numeric(std::string &output)
250 output.append(" SAFELIST");
253 virtual void OnUserQuit(userrec* user, std::string message)
255 this->OnCleanup(TYPE_USER,user);
262 /******************************************************************************************************/
264 class ModuleSafeListFactory : public ModuleFactory
267 ModuleSafeListFactory()
271 ~ModuleSafeListFactory()
275 virtual Module * CreateModule(Server* Me)
277 return new ModuleSafeList(Me);
282 extern "C" void * init_module( void )
284 return new ModuleSafeListFactory;