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 /** Holds a users m_safelist state
28 class ListData : public classbase
34 const std::string glob;
36 ListData() : list_start(0), list_position(0), list_ended(false) {};
37 ListData(long pos, time_t t, const std::string &pattern) : list_start(t), list_position(pos), list_ended(false), glob(pattern) {};
40 /* $ModDesc: A module overriding /list, and making it safe - stop those sendq problems. */
42 typedef std::vector<userrec *> UserList;
43 UserList listusers; /* vector of people doing a /list */
44 class ListTimer *timer;
46 /** To create a timer which recurs every second, we inherit from InspTimer.
47 * InspTimer is only one-shot however, so at the end of each Tick() we simply
48 * insert another of ourselves into the pending queue :)
50 class ListTimer : public InspTimer
56 InspIRCd* ServerInstance;
57 const std::string glob;
58 size_t ServerNameSize;
62 ListTimer(InspIRCd* Instance, long interval) : InspTimer(interval,Instance->Time()), ServerInstance(Instance)
64 ServerNameSize = 4 + strlen(ServerInstance->Config->ServerName);
67 virtual void Tick(time_t TIME)
74 for (UserList::iterator iter = listusers.begin(); iter != listusers.end(); iter++)
78 * - Get where they are up to
79 * - If it's more than total number of channels, erase
80 * them from the iterator, set go_again to true
81 * - If not, spool more channels
83 userrec* u = (userrec*)(*iter);
85 u->GetExt("safelist_cache", ld);
86 if ((size_t)ld->list_position > ServerInstance->chanlist.size())
88 u->Shrink("safelist_cache");
90 listusers.erase(iter);
95 ServerInstance->Log(DEBUG, "m_safelist.so: resuming spool of list to client %s at channel %ld", u->nick, ld->list_position);
97 /* Attempt to fill up to 25% the user's sendq with /LIST output */
101 ServerInstance->Log(DEBUG,"Channel %ld",ld->list_position);
102 if (!ld->list_position)
103 u->WriteServ("321 %s Channel :Users Name",u->nick);
104 chan = ServerInstance->GetChannelIndex(ld->list_position);
106 bool has_user = (chan && chan->HasUser(u));
107 if ((chan) && (((!(chan->modes[CM_PRIVATE])) && (!(chan->modes[CM_SECRET]))) || (has_user)))
109 bool display = match(chan->name, ld->glob.c_str());
110 long users = chan->GetUserCounter();
112 if ((users) && (display))
114 int counter = snprintf(buffer, MAXBUF, "322 %s %s %ld :[+%s] %s",u->nick, chan->name, users, chan->ChanModes(has_user), chan->topic);
115 /* Increment total plus linefeed */
116 amount_sent += counter + ServerNameSize;
117 ServerInstance->Log(DEBUG, "m_safelist.so: Sent %ld of safe %ld / 4", amount_sent, u->sendqmax);
118 u->WriteServ(std::string(buffer));
127 ld->list_ended = true;
128 u->WriteServ("323 %s :End of channel list.",u->nick);
135 while ((chan != NULL) && (amount_sent < (u->sendqmax / 4)));
139 if (listusers.size())
141 timer = new ListTimer(ServerInstance,1);
142 ServerInstance->Timers->AddTimer(timer);
151 class ModuleSafeList : public Module
154 ModuleSafeList(InspIRCd* Me) : Module::Module(Me)
159 virtual ~ModuleSafeList()
162 ServerInstance->Timers->DelTimer(timer);
165 virtual Version GetVersion()
167 return Version(1,0,0,0,VF_VENDOR,API_VERSION);
170 void Implements(char* List)
172 List[I_OnPreCommand] = List[I_OnCleanup] = List[I_OnUserQuit] = List[I_On005Numeric] = 1;
177 * Intercept the LIST command.
179 virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line)
181 /* If the command doesnt appear to be valid, we dont want to mess with it. */
185 if (command == "LIST")
187 return this->HandleList(parameters, pcnt, user);
194 * Handle (override) the LIST command.
196 int HandleList(const char** parameters, int pcnt, userrec* user)
198 /* First, let's check if the user is currently /list'ing */
200 user->GetExt("safelist_cache", ld);
204 /* user is already /list'ing, we don't want to do shit. */
208 time_t* last_list_time;
209 user->GetExt("safelist_last", last_list_time);
212 if (ServerInstance->Time() < (*last_list_time)+60)
214 user->WriteServ("NOTICE %s :*** Woah there, slow down a little, you can't /LIST so often!",user->nick);
218 DELETE(last_list_time);
219 user->Shrink("safelist_last");
223 * start at channel 0! ;)
225 ld = new ListData(0,ServerInstance->Time(), pcnt ? parameters[0] : "*");
226 user->Extend("safelist_cache", ld);
227 listusers.push_back(user);
229 time_t* llt = new time_t;
230 *llt = ServerInstance->Time();
231 user->Extend("safelist_last", llt);
235 timer = new ListTimer(ServerInstance,1);
236 ServerInstance->Timers->AddTimer(timer);
242 virtual void OnCleanup(int target_type, void* item)
244 if(target_type == TYPE_USER)
246 userrec* u = (userrec*)item;
248 u->GetExt("safelist_cache", ld);
251 u->Shrink("safelist_cache");
254 for (UserList::iterator iter = listusers.begin(); iter != listusers.end(); iter++)
256 userrec* u2 = (userrec*)(*iter);
259 listusers.erase(iter);
263 time_t* last_list_time;
264 u->GetExt("safelist_last", last_list_time);
267 DELETE(last_list_time);
268 u->Shrink("safelist_last");
273 virtual void On005Numeric(std::string &output)
275 output.append(" SAFELIST");
278 virtual void OnUserQuit(userrec* user, const std::string &message)
280 this->OnCleanup(TYPE_USER,user);
286 class ModuleSafeListFactory : public ModuleFactory
289 ModuleSafeListFactory()
293 ~ModuleSafeListFactory()
297 virtual Module * CreateModule(InspIRCd* Me)
299 return new ModuleSafeList(Me);
304 extern "C" void * init_module( void )
306 return new ModuleSafeListFactory;