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 "configreader.h"
26 class ListData : public classbase
32 const std::string glob;
34 ListData() : list_start(0), list_position(0), list_ended(false) {};
35 ListData(long pos, time_t t, const std::string &pattern) : list_start(t), list_position(pos), list_ended(false), glob(pattern) {};
38 /* $ModDesc: A module overriding /list, and making it safe - stop those sendq problems. */
40 typedef std::vector<userrec *> UserList;
41 UserList listusers; /* vector of people doing a /list */
44 * To create a timer which recurs every second, we inherit from InspTimer.
45 * InspTimer is only one-shot however, so at the end of each Tick() we simply
46 * insert another of ourselves into the pending queue :)
48 class ListTimer : public InspTimer
54 InspIRCd* ServerInstance;
55 const std::string glob;
59 ListTimer(InspIRCd* Instance, long interval) : InspTimer(interval,Instance->Time()), ServerInstance(Instance)
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 more than total number of channels, erase
76 * them from the iterator, set go_again to true
77 * - If not, spool more channels
79 userrec* u = (userrec*)(*iter);
81 u->GetExt("safelist_cache", ld);
82 if ((size_t)ld->list_position > ServerInstance->chanlist.size())
84 u->Shrink("safelist_cache");
86 listusers.erase(iter);
91 ServerInstance->Log(DEBUG, "m_safelist.so: resuming spool of list to client %s at channel %ld", u->nick, ld->list_position);
93 /* Attempt to fill up to half the user's sendq with /LIST output */
97 ServerInstance->Log(DEBUG,"Channel %ld",ld->list_position);
98 if (!ld->list_position)
99 u->WriteServ("321 %s Channel :Users Name",u->nick);
100 chan = ServerInstance->GetChannelIndex(ld->list_position);
102 bool has_user = (chan && chan->HasUser(u));
103 if ((chan) && (((!(chan->modes[CM_PRIVATE])) && (!(chan->modes[CM_SECRET]))) || (has_user)))
105 bool display = match(chan->name, ld->glob.c_str());
107 long users = chan->GetUserCounter();
108 if ((users) && (display))
110 int counter = snprintf(buffer,MAXBUF,"322 %s %s %ld :[+%s] %s",u->nick,chan->name,users,chan->ChanModes(has_user),chan->topic);
111 /* Increment total plus linefeed */
112 amount_sent += counter + 4 + strlen(ServerInstance->Config->ServerName);
113 ServerInstance->Log(DEBUG,"m_safelist.so: Sent %ld of safe %ld / 4",amount_sent,u->sendqmax);
114 u->WriteServ(std::string(buffer));
123 ld->list_ended = true;
124 u->WriteServ("323 %s :End of channel list.",u->nick);
131 while ((chan != NULL) && (amount_sent < (u->sendqmax / 4)));
135 ListTimer* MyTimer = new ListTimer(ServerInstance,1);
136 ServerInstance->Timers->AddTimer(MyTimer);
140 class ModuleSafeList : public Module
146 ModuleSafeList(InspIRCd* Me) : Module::Module(Me)
148 MyTimer = new ListTimer(ServerInstance,1);
149 ServerInstance->Timers->AddTimer(MyTimer);
152 virtual ~ModuleSafeList()
156 virtual Version GetVersion()
158 return Version(1,0,0,0,VF_VENDOR);
161 void Implements(char* List)
163 List[I_OnPreCommand] = List[I_OnCleanup] = List[I_OnUserQuit] = List[I_On005Numeric] = 1;
168 * Intercept the LIST command.
170 virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated)
172 /* If the command doesnt appear to be valid, we dont want to mess with it. */
176 if (command == "LIST")
178 return this->HandleList(parameters, pcnt, user);
185 * Handle (override) the LIST command.
187 int HandleList(const char** parameters, int pcnt, userrec* user)
189 /* First, let's check if the user is currently /list'ing */
191 user->GetExt("safelist_cache", ld);
195 /* user is already /list'ing, we don't want to do shit. */
199 time_t* last_list_time;
200 user->GetExt("safelist_last", last_list_time);
203 if (ServerInstance->Time() < (*last_list_time)+60)
205 user->WriteServ("NOTICE %s :*** Woah there, slow down a little, you can't /LIST so often!",user->nick);
209 DELETE(last_list_time);
210 user->Shrink("safelist_last");
214 * start at channel 0! ;)
216 ld = new ListData(0,ServerInstance->Time(), pcnt ? parameters[0] : "*");
217 user->Extend("safelist_cache", ld);
218 listusers.push_back(user);
220 time_t* llt = new time_t;
221 *llt = ServerInstance->Time();
222 user->Extend("safelist_last", llt);
227 virtual void OnCleanup(int target_type, void* item)
229 if(target_type == TYPE_USER)
231 userrec* u = (userrec*)item;
233 u->GetExt("safelist_cache", ld);
236 u->Shrink("safelist_cache");
239 for (UserList::iterator iter = listusers.begin(); iter != listusers.end(); iter++)
241 userrec* u2 = (userrec*)(*iter);
244 listusers.erase(iter);
248 time_t* last_list_time;
249 u->GetExt("safelist_last", last_list_time);
252 DELETE(last_list_time);
253 u->Shrink("safelist_last");
258 virtual void On005Numeric(std::string &output)
260 output.append(" SAFELIST");
263 virtual void OnUserQuit(userrec* user, const std::string &message)
265 this->OnCleanup(TYPE_USER,user);
271 class ModuleSafeListFactory : public ModuleFactory
274 ModuleSafeListFactory()
278 ~ModuleSafeListFactory()
282 virtual Module * CreateModule(InspIRCd* Me)
284 return new ModuleSafeList(Me);
289 extern "C" void * init_module( void )
291 return new ModuleSafeListFactory;