* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- * E-mail:
- * <brain@chatspike.net>
- * <Craig@chatspike.net>
- *
- * Written by Craig Edwards, Craig McLure, and others.
+ * InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
+ *
* This program is free but copyrighted software; see
- * the file COPYING for details.
+ * the file COPYING for details.
*
* ---------------------------------------------------
*/
-
-using namespace std;
#include "users.h"
#include "channels.h"
#include "modules.h"
-#include "helperfuncs.h"
-#include "message.h"
-#include <vector>
-
-extern time_t TIME;
+#include "configreader.h"
+#include "inspircd.h"
+#include "wildcard.h"
-class ListData
+/** Holds a users m_safelist state
+ */
+class ListData : public classbase
{
public:
long list_start;
long list_position;
bool list_ended;
+ const std::string glob;
ListData() : list_start(0), list_position(0), list_ended(false) {};
- ListData(long pos, time_t t) : list_start(t), list_position(pos), list_ended(false) {};
+ ListData(long pos, time_t t, const std::string &pattern) : list_start(t), list_position(pos), list_ended(false), glob(pattern) {};
};
/* $ModDesc: A module overriding /list, and making it safe - stop those sendq problems. */
typedef std::vector<userrec *> UserList;
+UserList listusers; /* vector of people doing a /list */
+class ListTimer *timer;
-class ModuleSafeList : public Module
+/** To create a timer which recurs every second, we inherit from InspTimer.
+ * InspTimer is only one-shot however, so at the end of each Tick() we simply
+ * insert another of ourselves into the pending queue :)
+ */
+class ListTimer : public InspTimer
{
private:
- Server *Srv;
- UserList listusers; /* vector of people doing a /list */
+
+ char buffer[MAXBUF];
+ chanrec *chan;
+ InspIRCd* ServerInstance;
+ const std::string glob;
+ size_t ServerNameSize;
+
public:
- ModuleSafeList(Server* Me) : Module::Module(Me)
- {
- Srv = Me;
- }
-
- virtual ~ModuleSafeList()
- {
- }
-
- virtual Version GetVersion()
- {
- return Version(1,0,0,0,VF_VENDOR);
- }
-
- void Implements(char* List)
- {
- List[I_OnPreCommand] = List[I_OnBackgroundTimer] = 1;
- }
- /*
- * OnPreCommand()
- * Intercept the LIST command.
- */
- virtual int OnPreCommand(std::string command, char **parameters, int pcnt, userrec *user, bool validated)
+ ListTimer(InspIRCd* Instance, long interval) : InspTimer(interval,Instance->Time()), ServerInstance(Instance)
{
- /* If the command doesnt appear to be valid, we dont want to mess with it. */
- if (!validated)
- return 0;
-
- if (command == "LIST")
- {
- return this->HandleList(parameters, pcnt, user);
- }
- return 0;
+ ServerNameSize = 4 + strlen(ServerInstance->Config->ServerName);
}
-
- /*
- * OnBackgroundTimer()
- * Spool off safelist information to users currently doing /list.
- */
- virtual void OnBackgroundTimer(time_t curtime)
+
+ virtual void Tick(time_t TIME)
{
bool go_again = true;
- chanrec *chan;
- char buffer[MAXBUF];
-
+
while (go_again)
{
go_again = false;
/*
* What we do here:
* - Get where they are up to
- * - If it's > GetChannelCount, erase them from the iterator, set go_again to true
- * - If not, spool the next 20 channels
+ * - If it's more than total number of channels, erase
+ * them from the iterator, set go_again to true
+ * - If not, spool more channels
*/
userrec* u = (userrec*)(*iter);
- ListData* ld = (ListData*)u->GetExt("safelist_cache");
- if (ld->list_position > Srv->GetChannelCount())
+ ListData* ld;
+ u->GetExt("safelist_cache", ld);
+ if ((size_t)ld->list_position > ServerInstance->chanlist->size())
{
u->Shrink("safelist_cache");
- delete ld;
+ DELETE(ld);
listusers.erase(iter);
go_again = true;
break;
}
-
- log(DEBUG, "m_safelist.so: resuming spool of list to client %s at channel %ld", u->nick, ld->list_position);
+
+ ServerInstance->Log(DEBUG, "m_safelist.so: resuming spool of list to client %s at channel %ld", u->nick, ld->list_position);
chan = NULL;
- /* Attempt to fill up to half the user's sendq with /LIST output */
+ /* Attempt to fill up to 25% the user's sendq with /LIST output */
long amount_sent = 0;
do
{
- log(DEBUG,"Channel %ld",ld->list_position);
- chan = Srv->GetChannelIndex(ld->list_position);
+ ServerInstance->Log(DEBUG,"Channel %ld",ld->list_position);
+ if (!ld->list_position)
+ u->WriteServ("321 %s Channel :Users Name",u->nick);
+ chan = ServerInstance->GetChannelIndex(ld->list_position);
/* spool details */
- if (chan)
+ bool has_user = (chan && chan->HasUser(u));
+ if ((chan) && (chan->modes[CM_PRIVATE]))
+ {
+ bool display = match(chan->name, ld->glob.c_str());
+ long users = chan->GetUserCounter();
+ if ((users) && (display))
+ {
+ int counter = snprintf(buffer, MAXBUF, "322 %s *", u->nick);
+ amount_sent += counter + ServerNameSize;
+ ServerInstance->Log(DEBUG, "m_safelist.so: Sent %ld of safe %ld / 4", amount_sent, u->sendqmax);
+ u->WriteServ(std::string(buffer));
+ }
+ }
+ else if ((chan) && (((!(chan->modes[CM_PRIVATE])) && (!(chan->modes[CM_SECRET]))) || (has_user)))
{
- /* Increment total plus linefeed */
- int counter = snprintf(buffer,MAXBUF,"322 %s %s %d :[+%s] %s",u->nick,chan->name,usercount_i(chan),chanmodes(chan,has_channel(u,chan)),chan->topic);
- amount_sent += counter + 2;
- log(DEBUG,"m_safelist.so: Sent %ld of safe %ld / 2",amount_sent,u->sendqmax);
- WriteServ(u->fd,"%s",buffer);
+ bool display = match(chan->name, ld->glob.c_str());
+ long users = chan->GetUserCounter();
+
+ if ((users) && (display))
+ {
+ int counter = snprintf(buffer, MAXBUF, "322 %s %s %ld :[+%s] %s",u->nick, chan->name, users, chan->ChanModes(has_user), chan->topic);
+ /* Increment total plus linefeed */
+ amount_sent += counter + ServerNameSize;
+ ServerInstance->Log(DEBUG, "m_safelist.so: Sent %ld of safe %ld / 4", amount_sent, u->sendqmax);
+ u->WriteServ(std::string(buffer));
+ }
}
else
{
- if (!ld->list_ended)
+ if (!chan)
{
- ld->list_ended = true;
- WriteServ(u->fd,"323 %s :End of channel list.",u->nick);
+ if (!ld->list_ended)
+ {
+ ld->list_ended = true;
+ u->WriteServ("323 %s :End of channel list.",u->nick);
+ }
}
}
ld->list_position++;
}
- while ((chan != NULL) && (amount_sent < (u->sendqmax / 2)));
+ while ((chan != NULL) && (amount_sent < (u->sendqmax / 4)));
}
}
+
+ if (listusers.size())
+ {
+ timer = new ListTimer(ServerInstance,1);
+ ServerInstance->Timers->AddTimer(timer);
+ }
+ else
+ {
+ timer = NULL;
+ }
+ }
+};
+
+class ModuleSafeList : public Module
+{
+ public:
+ ModuleSafeList(InspIRCd* Me) : Module::Module(Me)
+ {
+ timer = NULL;
+ }
+
+ virtual ~ModuleSafeList()
+ {
+ if (timer)
+ ServerInstance->Timers->DelTimer(timer);
+ }
+
+ virtual Version GetVersion()
+ {
+ return Version(1,1,0,0,VF_VENDOR,API_VERSION);
+ }
+
+ void Implements(char* List)
+ {
+ List[I_OnPreCommand] = List[I_OnCleanup] = List[I_OnUserQuit] = List[I_On005Numeric] = 1;
}
+
+ /*
+ * OnPreCommand()
+ * Intercept the LIST command.
+ */
+ virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line)
+ {
+ /* If the command doesnt appear to be valid, we dont want to mess with it. */
+ if (!validated)
+ return 0;
+ if (command == "LIST")
+ {
+ return this->HandleList(parameters, pcnt, user);
+ }
+ return 0;
+ }
+
/*
* HandleList()
* Handle (override) the LIST command.
*/
- int HandleList(char** parameters, int pcnt, userrec* user)
+ int HandleList(const char** parameters, int pcnt, userrec* user)
{
/* First, let's check if the user is currently /list'ing */
- ListData *ld = (ListData*)user->GetExt("safelist_cache");
+ ListData *ld;
+ user->GetExt("safelist_cache", ld);
if (ld)
{
return 1;
}
- time_t* last_list_time = (time_t*)user->GetExt("safelist_last");
+ /* Work around mIRC suckyness. YOU SUCK, KHALED! */
+ if ((pcnt == 1) && (*parameters[0] == '<'))
+ pcnt = 0;
+
+ time_t* last_list_time;
+ user->GetExt("safelist_last", last_list_time);
if (last_list_time)
{
- if (TIME < (*last_list_time)+60)
+ if (ServerInstance->Time() < (*last_list_time)+60)
{
- WriteServ(user->fd,"NOTICE %s :*** Woah there, slow down a little, you can't /LIST so often!",user->nick);
+ user->WriteServ("NOTICE %s :*** Woah there, slow down a little, you can't /LIST so often!",user->nick);
+ user->WriteServ("321 %s Channel :Users Name",user->nick);
+ user->WriteServ("323 %s :End of channel list.",user->nick);
return 1;
}
- delete last_list_time;
+ DELETE(last_list_time);
user->Shrink("safelist_last");
}
- /* no? let's check when they did a /list last.. */
- /*if ((ld) && (*list_start >= TIME - 100))
- {
- Srv->SendServ(user->fd,"NOTICE "+std::string(user->nick)+" :*** You are attempting to LIST too quickly. Please wait a while.");
- return 1;
- }*/
-
/*
* start at channel 0! ;)
*/
- ld = new ListData(0,TIME);
- user->Extend("safelist_cache", (char*)ld);
+ ld = new ListData(0,ServerInstance->Time(), pcnt ? parameters[0] : "*");
+ user->Extend("safelist_cache", ld);
listusers.push_back(user);
time_t* llt = new time_t;
- *llt = TIME;
- user->Extend("safelist_last",(char*)llt);
-
- WriteServ(user->fd,"321 %s Channel :Users Name",user->nick);
- /*
- * If we can, we try and fill up the user's sendq right now with the first batch of channels,
- * which on a small net, may be ALL of them.
- */
- this->OnBackgroundTimer(TIME);
+ *llt = ServerInstance->Time();
+ user->Extend("safelist_last", llt);
+
+ if (!timer)
+ {
+ timer = new ListTimer(ServerInstance,1);
+ ServerInstance->Timers->AddTimer(timer);
+ }
+
return 1;
}
+
+ virtual void OnCleanup(int target_type, void* item)
+ {
+ if(target_type == TYPE_USER)
+ {
+ userrec* u = (userrec*)item;
+ ListData* ld;
+ u->GetExt("safelist_cache", ld);
+ if (ld)
+ {
+ u->Shrink("safelist_cache");
+ DELETE(ld);
+ }
+ for (UserList::iterator iter = listusers.begin(); iter != listusers.end(); iter++)
+ {
+ userrec* u2 = (userrec*)(*iter);
+ if (u2 == u)
+ {
+ listusers.erase(iter);
+ break;
+ }
+ }
+ time_t* last_list_time;
+ u->GetExt("safelist_last", last_list_time);
+ if (last_list_time)
+ {
+ DELETE(last_list_time);
+ u->Shrink("safelist_last");
+ }
+ }
+ }
+
+ virtual void On005Numeric(std::string &output)
+ {
+ output.append(" SAFELIST");
+ }
+
+ virtual void OnUserQuit(userrec* user, const std::string &message)
+ {
+ this->OnCleanup(TYPE_USER,user);
+ }
+
};
-
-
-
-/******************************************************************************************************/
-
+
+
class ModuleSafeListFactory : public ModuleFactory
{
public:
{
}
- virtual Module * CreateModule(Server* Me)
+ virtual Module * CreateModule(InspIRCd* Me)
{
return new ModuleSafeList(Me);
}