Added m_safelist. This was originally w00t's code, but i bastardized it (just a little)

WARNING: It's not finished yet and shouldnt be used, it might crash at this point in time if a user /quit's while listing.
YOU HAVE BEEN WARNED! WITH A SPORK!


git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@3289 e03df62e-2008-0410-955e-edbf42e46eb7

1 files changed, 231 insertions, 0 deletions

diff --git a/src/modules/m_safelist.cpp b/src/modules/m_safelist.cpp
new file mode 100644
index 000000000..b7bc502f3
--- /dev/null
+++ b/src/modules/m_safelist.cpp
@@ -0,0 +1,231 @@
+/*       +------------------------------------+
+ *       | 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.
+ * This program is free but copyrighted software; see
+ *	    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;
+
+class ListData
+{
+ public:
+	long list_start;
+	long list_position;
+	bool list_ended;
+
+	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) {};
+};
+
+/* $ModDesc: A module overriding /list, and making it safe - stop those sendq problems. */
+ 
+typedef std::vector<userrec *> UserList;
+
+class ModuleSafeList : public Module
+{
+ private:
+	 Server *Srv;
+	 UserList listusers;	/* vector of people doing a /list */
+ 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)
+	{
+		/* 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;
+	}
+	
+	/*
+	 * OnBackgroundTimer()
+	 *   Spool off safelist information to users currently doing /list.
+	 */
+	virtual void OnBackgroundTimer(time_t curtime)
+	{
+		bool go_again = true;
+		chanrec *chan;
+		char buffer[MAXBUF];
+ 
+		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 > GetChannelCount, erase them from the iterator, set go_again to true
+				 *  - If not, spool the next 20 channels
+				 */
+				userrec* u = (userrec*)(*iter);
+				ListData* ld = (ListData*)u->GetExt("safelist_cache");
+				if (ld->list_position > Srv->GetChannelCount())
+				{
+					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);
+					chan = Srv->GetChannelIndex(ld->list_position);
+					/* spool details */
+					if (chan)
+					{
+						/* 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);
+					}
+					else
+					{
+						if (!ld->list_ended)
+						{
+							ld->list_ended = true;
+							WriteServ(u->fd,"323 %s :End of channel list.",u->nick);
+						}
+					}
+
+					ld->list_position++;
+				}
+				while ((chan != NULL) && (amount_sent < (u->sendqmax / 2)));
+			}
+		}
+	}
+ 
+	/*
+	 * HandleList()
+	 *   Handle (override) the LIST command.
+	 */
+	int HandleList(char** parameters, int pcnt, userrec* user)
+	{
+		/* First, let's check if the user is currently /list'ing */
+		ListData *ld = (ListData*)user->GetExt("safelist_cache");
+ 
+		if (ld)
+		{
+			/* user is already /list'ing, we don't want to do shit. */
+			return 1;
+		}
+
+		time_t* last_list_time = (time_t*)user->GetExt("safelist_last");
+		if (last_list_time)
+		{
+			if (TIME < (*last_list_time)+60)
+			{
+				WriteServ(user->fd,"NOTICE %s :*** Woah there, slow down a little, you can't /LIST so often!",user->nick);
+				return 1;
+			}
+
+			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);
+		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);
+		return 1;
+	}
+};
+ 
+ 
+ 
+/******************************************************************************************************/
+ 
+class ModuleSafeListFactory : public ModuleFactory
+{
+ public:
+	ModuleSafeListFactory()
+	{
+	}
+ 
+	~ModuleSafeListFactory()
+	{
+	}
+ 
+	virtual Module * CreateModule(Server* Me)
+	{
+		return new ModuleSafeList(Me);
+	}
+ 
+};
+ 
+extern "C" void * init_module( void )
+{
+	return new ModuleSafeListFactory;
+}