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 */
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;
61 ListTimer(InspIRCd* Instance, long interval) : InspTimer(interval,Instance->Time()), ServerInstance(Instance)
65 virtual void Tick(time_t TIME)
72 for (UserList::iterator iter = listusers.begin(); iter != listusers.end(); iter++)
76 * - Get where they are up to
77 * - If it's more than total number of channels, erase
78 * them from the iterator, set go_again to true
79 * - If not, spool more channels
81 userrec* u = (userrec*)(*iter);
83 u->GetExt("safelist_cache", ld);
84 if ((size_t)ld->list_position > ServerInstance->chanlist.size())
86 u->Shrink("safelist_cache");
88 listusers.erase(iter);
93 ServerInstance->Log(DEBUG, "m_safelist.so: resuming spool of list to client %s at channel %ld", u->nick, ld->list_position);
95 /* Attempt to fill up to half the user's sendq with /LIST output */
99 ServerInstance->Log(DEBUG,"Channel %ld",ld->list_position);
100 if (!ld->list_position)
101 u->WriteServ("321 %s Channel :Users Name",u->nick);
102 chan = ServerInstance->GetChannelIndex(ld->list_position);
104 bool has_user = (chan && chan->HasUser(u));
105 if ((chan) && (((!(chan->modes[CM_PRIVATE])) && (!(chan->modes[CM_SECRET]))) || (has_user)))
107 bool display = match(chan->name, ld->glob.c_str());
109 long users = chan->GetUserCounter();
110 if ((users) && (display))
112 int counter = snprintf(buffer,MAXBUF,"322 %s %s %ld :[+%s] %s",u->nick,chan->name,users,chan->ChanModes(has_user),chan->topic);
113 /* Increment total plus linefeed */
114 amount_sent += counter + 4 + strlen(ServerInstance->Config->ServerName);
115 ServerInstance->Log(DEBUG,"m_safelist.so: Sent %ld of safe %ld / 4",amount_sent,u->sendqmax);
116 u->WriteServ(std::string(buffer));
125 ld->list_ended = true;
126 u->WriteServ("323 %s :End of channel list.",u->nick);
133 while ((chan != NULL) && (amount_sent < (u->sendqmax / 4)));
137 ListTimer* MyTimer = new ListTimer(ServerInstance,1);
138 ServerInstance->Timers->AddTimer(MyTimer);
142 class ModuleSafeList : public Module
148 ModuleSafeList(InspIRCd* Me) : Module::Module(Me)
150 MyTimer = new ListTimer(ServerInstance,1);
151 ServerInstance->Timers->AddTimer(MyTimer);
154 virtual ~ModuleSafeList()
158 virtual Version GetVersion()
160 return Version(1,0,0,0,VF_VENDOR);
163 void Implements(char* List)
165 List[I_OnPreCommand] = List[I_OnCleanup] = List[I_OnUserQuit] = List[I_On005Numeric] = 1;
170 * Intercept the LIST command.
172 virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line)
174 /* If the command doesnt appear to be valid, we dont want to mess with it. */
178 if (command == "LIST")
180 return this->HandleList(parameters, pcnt, user);
187 * Handle (override) the LIST command.
189 int HandleList(const char** parameters, int pcnt, userrec* user)
191 /* First, let's check if the user is currently /list'ing */
193 user->GetExt("safelist_cache", ld);
197 /* user is already /list'ing, we don't want to do shit. */
201 time_t* last_list_time;
202 user->GetExt("safelist_last", last_list_time);
205 if (ServerInstance->Time() < (*last_list_time)+60)
207 user->WriteServ("NOTICE %s :*** Woah there, slow down a little, you can't /LIST so often!",user->nick);
211 DELETE(last_list_time);
212 user->Shrink("safelist_last");
216 * start at channel 0! ;)
218 ld = new ListData(0,ServerInstance->Time(), pcnt ? parameters[0] : "*");
219 user->Extend("safelist_cache", ld);
220 listusers.push_back(user);
222 time_t* llt = new time_t;
223 *llt = ServerInstance->Time();
224 user->Extend("safelist_last", llt);
229 virtual void OnCleanup(int target_type, void* item)
231 if(target_type == TYPE_USER)
233 userrec* u = (userrec*)item;
235 u->GetExt("safelist_cache", ld);
238 u->Shrink("safelist_cache");
241 for (UserList::iterator iter = listusers.begin(); iter != listusers.end(); iter++)
243 userrec* u2 = (userrec*)(*iter);
246 listusers.erase(iter);
250 time_t* last_list_time;
251 u->GetExt("safelist_last", last_list_time);
254 DELETE(last_list_time);
255 u->Shrink("safelist_last");
260 virtual void On005Numeric(std::string &output)
262 output.append(" SAFELIST");
265 virtual void OnUserQuit(userrec* user, const std::string &message)
267 this->OnCleanup(TYPE_USER,user);
273 class ModuleSafeListFactory : public ModuleFactory
276 ModuleSafeListFactory()
280 ~ModuleSafeListFactory()
284 virtual Module * CreateModule(InspIRCd* Me)
286 return new ModuleSafeList(Me);
291 extern "C" void * init_module( void )
293 return new ModuleSafeListFactory;