* | 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-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/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 <vector>
-#include "configreader.h"
#include "inspircd.h"
-extern time_t TIME;
-
-extern InspIRCd* ServerInstance;
-
+/** Holds a users m_safelist state
+ */
class ListData : public classbase
{
public:
long list_start;
long list_position;
bool list_ended;
+ const std::string glob;
+ int minusers;
+ int maxusers;
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, int mi, int ma) : list_start(t), list_position(pos), list_ended(false), glob(pattern), minusers(mi), maxusers(ma) {};
};
/* $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 */
-
-/*
- * 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:
-
- char buffer[MAXBUF];
- chanrec *chan;
-
-
- public:
-
- ListTimer(long interval) : InspTimer(interval,TIME)
- {
- }
-
- virtual void Tick(time_t TIME)
- {
- bool go_again = true;
-
- while (go_again)
- {
- go_again = false;
- for (UserList::iterator iter = listusers.begin(); iter != listusers.end(); iter++)
- {
- /*
- * What we do here:
- * - Get where they are up to
- * - 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;
- u->GetExt("safelist_cache", ld);
- if ((size_t)ld->list_position > ServerInstance->chanlist.size())
- {
- u->Shrink("safelist_cache");
- 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);
- chan = NULL;
- /* Attempt to fill up to half the user's sendq with /LIST output */
- long amount_sent = 0;
- do
- {
- 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 */
- bool has_user = (chan && chan->HasUser(u));
- if ((chan) && (((!(chan->modes[CM_PRIVATE])) && (!(chan->modes[CM_SECRET]))) || (has_user)))
- {
- long users = chan->GetUserCounter();
- if (users)
- {
- 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 + 4 + strlen(ServerInstance->Config->ServerName);
- log(DEBUG,"m_safelist.so: Sent %ld of safe %ld / 4",amount_sent,u->sendqmax);
- u->WriteServ(std::string(buffer));
- }
- }
- else
- {
- if (!chan)
- {
- 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 / 4)));
- }
- }
-
- ListTimer* MyTimer = new ListTimer(1);
- ServerInstance->Timers->AddTimer(MyTimer);
- }
-};
class ModuleSafeList : public Module
{
- private:
-
- ListTimer* MyTimer;
+ time_t ThrottleSecs;
+ size_t ServerNameSize;
+ int global_listing;
+ int LimitList;
+ SimpleExtItem<ListData> listData;
+ LocalIntExt listTime;
public:
- ModuleSafeList(InspIRCd* Me) : Module::Module(Me)
+ ModuleSafeList() : listData("safelist_data", this), listTime("safelist_last", this)
{
- MyTimer = new ListTimer(1);
- ServerInstance->Timers->AddTimer(MyTimer);
+ OnRehash(NULL);
+ Extensible::Register(&listData);
+ Extensible::Register(&listTime);
+ Implementation eventlist[] = { I_OnBufferFlushed, I_OnPreCommand, I_On005Numeric, I_OnRehash };
+ ServerInstance->Modules->Attach(eventlist, this, 4);
}
-
- virtual ~ModuleSafeList()
+
+ ~ModuleSafeList()
{
}
-
- virtual Version GetVersion()
+
+ void OnRehash(User* user)
{
- return Version(1,0,0,0,VF_VENDOR);
+ ConfigReader MyConf;
+ ThrottleSecs = MyConf.ReadInteger("safelist", "throttle", "60", 0, true);
+ LimitList = MyConf.ReadInteger("safelist", "maxlisters", "50", 0, true);
+ ServerNameSize = strlen(ServerInstance->Config->ServerName) + 4;
+ global_listing = 0;
}
-
- void Implements(char* List)
+
+ Version GetVersion()
{
- List[I_OnPreCommand] = List[I_OnCleanup] = List[I_OnUserQuit] = List[I_On005Numeric] = 1;
+ return Version("A module overriding /list, and making it safe - stop those sendq problems.",VF_VENDOR,API_VERSION);
}
+
/*
* OnPreCommand()
* Intercept the LIST command.
- */
- virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated)
+ */
+ ModResult OnPreCommand(std::string &command, std::vector<std::string> ¶meters, User *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;
-
+ return MOD_RES_PASSTHRU;
+
if (command == "LIST")
{
- return this->HandleList(parameters, pcnt, user);
+ return this->HandleList(parameters, user);
}
- return 0;
+ return MOD_RES_PASSTHRU;
}
-
+
/*
* HandleList()
* Handle (override) the LIST command.
*/
- int HandleList(const char** parameters, int pcnt, userrec* user)
+ ModResult HandleList(const std::vector<std::string> ¶meters, User* user)
{
+ int pcnt = parameters.size();
+ int minusers = 0, maxusers = 0;
+
+ if (global_listing >= LimitList && !IS_OPER(user))
+ {
+ user->WriteServ("NOTICE %s :*** Server load is currently too heavy. Please try again later.", user->nick.c_str());
+ user->WriteNumeric(321, "%s Channel :Users Name",user->nick.c_str());
+ user->WriteNumeric(323, "%s :End of channel list.",user->nick.c_str());
+ return MOD_RES_DENY;
+ }
+
/* First, let's check if the user is currently /list'ing */
- ListData *ld;
- user->GetExt("safelist_cache", ld);
-
+ ListData *ld = listData.get(user);
+
if (ld)
{
/* user is already /list'ing, we don't want to do shit. */
- return 1;
+ return MOD_RES_DENY;
}
- time_t* last_list_time;
- user->GetExt("safelist_last", last_list_time);
- if (last_list_time)
+ /* Work around mIRC suckyness. YOU SUCK, KHALED! */
+ if (pcnt == 1)
{
- if (TIME < (*last_list_time)+60)
+ if (parameters[0][0] == '<')
+ {
+ maxusers = atoi(parameters[0].c_str()+1);
+ ServerInstance->Logs->Log("m_safelist",DEBUG,"Max users: %d", maxusers);
+ pcnt = 0;
+ }
+ else if (parameters[0][0] == '>')
{
- user->WriteServ("NOTICE %s :*** Woah there, slow down a little, you can't /LIST so often!",user->nick);
- return 1;
+ minusers = atoi(parameters[0].c_str()+1);
+ ServerInstance->Logs->Log("m_safelist",DEBUG,"Min users: %d", minusers);
+ pcnt = 0;
}
+ }
- DELETE(last_list_time);
- user->Shrink("safelist_last");
+ time_t last_list_time = listTime.get(user);
+ if (last_list_time && ServerInstance->Time() < last_list_time + ThrottleSecs)
+ {
+ user->WriteServ("NOTICE %s :*** Woah there, slow down a little, you can't /LIST so often!",user->nick.c_str());
+ user->WriteNumeric(321, "%s Channel :Users Name",user->nick.c_str());
+ user->WriteNumeric(323, "%s :End of channel list.",user->nick.c_str());
+ return MOD_RES_DENY;
}
-
+
/*
* start at channel 0! ;)
*/
- ld = new ListData(0,TIME);
- user->Extend("safelist_cache", ld);
- listusers.push_back(user);
-
- time_t* llt = new time_t;
- *llt = TIME;
- user->Extend("safelist_last", llt);
-
- return 1;
+ ld = new ListData(0,ServerInstance->Time(), (pcnt && (parameters[0][0] != '<' && parameters[0][0] != '>')) ? parameters[0] : "*", minusers, maxusers);
+ listData.set(user, ld);
+ listTime.set(user, ServerInstance->Time());
+
+ user->WriteNumeric(321, "%s Channel :Users Name",user->nick.c_str());
+
+ global_listing++;
+
+ return MOD_RES_DENY;
}
- virtual void OnCleanup(int target_type, void* item)
+ void OnBufferFlushed(User* user)
{
- if(target_type == TYPE_USER)
+ char buffer[MAXBUF];
+ ListData* ld = listData.get(user);
+ if (ld)
{
- 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++)
+ Channel* chan = NULL;
+ unsigned long amount_sent = 0;
+ do
{
- userrec* u2 = (userrec*)(*iter);
- if (u2 == u)
+ chan = ServerInstance->GetChannelIndex(ld->list_position);
+ bool is_special = (chan && (chan->HasUser(user) || user->HasPrivPermission("channels/auspex")));
+ long users = chan ? chan->GetUserCounter() : 0;
+
+ bool too_few = (ld->minusers && (users <= ld->minusers));
+ bool too_many = (ld->maxusers && (users >= ld->maxusers));
+
+ if (chan && (too_many || too_few))
{
- listusers.erase(iter);
- break;
+ ld->list_position++;
+ continue;
}
+
+ if (chan)
+ {
+ bool display = (InspIRCd::Match(chan->name, ld->glob) || (!chan->topic.empty() && InspIRCd::Match(chan->topic, ld->glob)));
+
+ if (!users || !display)
+ {
+ ld->list_position++;
+ continue;
+ }
+
+ /* +s, not in chan / not got channels/auspex */
+ if (chan->IsModeSet('s') && !is_special)
+ {
+ ld->list_position++;
+ continue;
+ }
+
+ if (chan->IsModeSet('p') && !is_special)
+ {
+ /* Channel is +p and user is outside/not privileged */
+ int counter = snprintf(buffer, MAXBUF, "322 %s * %ld :", user->nick.c_str(), users);
+ amount_sent += counter + ServerNameSize;
+ user->WriteServ(std::string(buffer));
+ }
+ else
+ {
+ /* User is in the channel/privileged, channel is not +s */
+ int counter = snprintf(buffer, MAXBUF, "322 %s %s %ld :[+%s] %s", user->nick.c_str(), chan->name.c_str(), users, chan->ChanModes(is_special), chan->topic.c_str());
+ amount_sent += counter + ServerNameSize;
+ user->WriteServ(std::string(buffer));
+ }
+ }
+ else
+ {
+ if (!ld->list_ended)
+ {
+ ld->list_ended = true;
+ user->WriteNumeric(323, "%s :End of channel list.",user->nick.c_str());
+ }
+ }
+
+ ld->list_position++;
}
- time_t* last_list_time;
- u->GetExt("safelist_last", last_list_time);
- if (last_list_time)
+ while ((chan != NULL) && (amount_sent < (user->MyClass->GetSendqMax() / 4)));
+ if (ld->list_ended)
{
- DELETE(last_list_time);
- u->Shrink("safelist_last");
+ listData.unset(user);
+ global_listing--;
}
}
}
- virtual void On005Numeric(std::string &output)
+ 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:
- ModuleSafeListFactory()
- {
- }
-
- ~ModuleSafeListFactory()
- {
- }
-
- virtual Module * CreateModule(InspIRCd* Me)
- {
- return new ModuleSafeList(Me);
- }
-
-};
-
-extern "C" void * init_module( void )
-{
- return new ModuleSafeListFactory;
-}
+
+MODULE_INIT(ModuleSafeList)
projects / user / henk / code / inspircd.git / blobdiff