]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_safelist.cpp
Update all wiki links to point to the new wiki. This was done automatically with...
[user/henk/code/inspircd.git] / src / modules / m_safelist.cpp
index f318300c5c9690b46ba2a3ba3d7578e37fa7acfa..7a7fe742a0ee5a318c356281e5c39224f5a32dd7 100644 (file)
@@ -2,21 +2,16 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *  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.
  *
  * ---------------------------------------------------
  */
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
-#include "configreader.h"
+
 #include "inspircd.h"
-#include "wildcard.h"
 
 /** Holds a users m_safelist state
  */
@@ -27,185 +22,86 @@ class ListData : public classbase
        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, const std::string &pattern) : list_start(t), list_position(pos), list_ended(false), glob(pattern) {};
+       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 */
-class ListTimer *timer;
-
-/** 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;
-       InspIRCd* ServerInstance;
-       const std::string glob;
+class ModuleSafeList : public Module
+{
+       time_t ThrottleSecs;
        size_t ServerNameSize;
-
+       int global_listing;
+       int LimitList;
  public:
-
-       ListTimer(InspIRCd* Instance, long interval) : InspTimer(interval,Instance->Time()), ServerInstance(Instance)
+       ModuleSafeList(InspIRCd* Me) : Module(Me)
        {
-               ServerNameSize = 4 + strlen(ServerInstance->Config->ServerName);
+               OnRehash(NULL, "");
+               Implementation eventlist[] = { I_OnBufferFlushed, I_OnPreCommand, I_OnCleanup, I_OnUserQuit, I_On005Numeric, I_OnRehash };
+               ServerInstance->Modules->Attach(eventlist, this, 6);
        }
 
-       virtual void Tick(time_t TIME)
+       virtual ~ModuleSafeList()
        {
-               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;
-                               }
-
-                               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 25% the user's sendq with /LIST output */
-                               long amount_sent = 0;
-                               do
-                               {
-                                       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 */
-                                       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)))
-                                       {
-                                               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 (!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)));
-                       }
-               }
-
-               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()
+       virtual void OnRehash(User* user, const std::string &parameter)
        {
-               if (timer)
-                       ServerInstance->Timers->DelTimer(timer);
+               ConfigReader MyConf(ServerInstance);
+               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;
        }
+
        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;
+               return Version("$Id$",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, const std::string &original_line)
+        */
+       virtual int OnPreCommand(std::string &command, std::vector<std::string> &parameters, 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;
+
                if (command == "LIST")
                {
-                       return this->HandleList(parameters, pcnt, user);
+                       return this->HandleList(parameters, user);
                }
                return 0;
        }
-       
+
        /*
         * HandleList()
         *   Handle (override) the LIST command.
         */
-       int HandleList(const char** parameters, int pcnt, userrec* user)
+       int HandleList(const std::vector<std::string> &parameters, 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 1;
+               }
+
                /* First, let's check if the user is currently /list'ing */
                ListData *ld;
                user->GetExt("safelist_cache", ld);
+
                if (ld)
                {
                        /* user is already /list'ing, we don't want to do shit. */
@@ -213,71 +109,150 @@ class ModuleSafeList : public Module
                }
 
                /* Work around mIRC suckyness. YOU SUCK, KHALED! */
-               if ((pcnt == 1) && (*parameters[0] == '<'))
-                       pcnt = 0;
+               if (pcnt == 1)
+               {
+                       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] == '>')
+                       {
+                               minusers = atoi(parameters[0].c_str()+1);
+                               ServerInstance->Logs->Log("m_safelist",DEBUG,"Min users: %d", minusers);
+                               pcnt = 0;
+                       }
+               }
 
                time_t* last_list_time;
                user->GetExt("safelist_last", last_list_time);
                if (last_list_time)
                {
-                       if (ServerInstance->Time() < (*last_list_time)+60)
+                       if (ServerInstance->Time() < (*last_list_time)+ThrottleSecs)
                        {
-                               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);
+                               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 1;
                        }
 
-                       DELETE(last_list_time);
+                       delete last_list_time;
                        user->Shrink("safelist_last");
                }
+
+
                /*
                 * start at channel 0! ;)
                 */
-               ld = new ListData(0,ServerInstance->Time(), pcnt ? parameters[0] : "*");
+               ld = new ListData(0,ServerInstance->Time(), (pcnt && (parameters[0][0] != '<' && parameters[0][0] != '>')) ? parameters[0] : "*", minusers, maxusers);
                user->Extend("safelist_cache", ld);
-               listusers.push_back(user);
 
                time_t* llt = new time_t;
                *llt = ServerInstance->Time();
                user->Extend("safelist_last", llt);
 
-               if (!timer)
-               {
-                       timer = new ListTimer(ServerInstance,1);
-                       ServerInstance->Timers->AddTimer(timer);
-               }
+               user->WriteNumeric(321, "%s Channel :Users Name",user->nick.c_str());
+
+               global_listing++;
 
                return 1;
        }
 
+       virtual void OnBufferFlushed(User* user)
+       {
+               char buffer[MAXBUF];
+               ListData* ld;
+               if (user->GetExt("safelist_cache", ld))
+               {
+                       Channel* chan = NULL;
+                       unsigned long amount_sent = 0;
+                       do
+                       {
+                               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))
+                               {
+                                       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++;
+                       }
+                       while ((chan != NULL) && (amount_sent < (user->MyClass->GetSendqMax() / 4)));
+                       if (ld->list_ended)
+                       {
+                               user->Shrink("safelist_cache");
+                               delete ld;
+                               global_listing--;
+                       }
+               }
+       }
+
        virtual void OnCleanup(int target_type, void* item)
        {
                if(target_type == TYPE_USER)
                {
-                       userrec* u = (userrec*)item;
+                       User* u = (User*)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;
-                               }
+                               delete ld;
+                               global_listing--;
                        }
                        time_t* last_list_time;
                        u->GetExt("safelist_last", last_list_time);
                        if (last_list_time)
                        {
-                               DELETE(last_list_time);
+                               delete last_list_time;
                                u->Shrink("safelist_last");
                        }
                }
@@ -288,33 +263,11 @@ class ModuleSafeList : public Module
                output.append(" SAFELIST");
        }
 
-       virtual void OnUserQuit(userrec* user, const std::string &message)
+       virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_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)