inspircd/src/channels.cpp

/*   +------------------------------------+
 *   | 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 <string>
#include <map>
#include <sstream>
#include <vector>
#include <deque>
#include "configreader.h"
#include "inspircd.h"
#include "hash_map.h"
#include "users.h"
#include "ctables.h"
#include "globals.h"
#include "modules.h"
#include "dynamic.h"
#include "commands.h"
#include "wildcard.h"
#include "message.h"
#include "mode.h"
#include "xline.h"
#include "inspstring.h"
#include "helperfuncs.h"
#include "typedefs.h"

extern ServerConfig* Config;

extern int MODCOUNT;
extern std::vector<Module*> modules;
extern std::vector<ircd_module*> factory;
extern time_t TIME;
extern chan_hash chanlist;


chanrec* ForceChan(chanrec* Ptr,ucrec *a,userrec* user, int created);

chanrec::chanrec()
{
	*name = *topic = *setby = *key = 0;
	created = topicset = limit = 0;
	internal_userlist.clear();
	memset(&modes,0,64);
}

void chanrec::SetCustomMode(char mode,bool mode_on)
{
	modes[mode-65] = mode_on;
	if (!mode_on)
		this->SetCustomModeParam(mode,"",false);
}


void chanrec::SetCustomModeParam(char mode,char* parameter,bool mode_on)
{
	log(DEBUG,"SetCustomModeParam called");
	
	CustomModeList::iterator n = custom_mode_params.find(mode);	

	if (mode_on)
	{
		if (n == custom_mode_params.end())
		{
			custom_mode_params[mode] = strdup(parameter);
			log(DEBUG,"Custom mode parameter %c %s added",mode,parameter);
		}
		else
		{
			log(DEBUG, "Tried to set custom mode parameter for %c '%s' when it was already '%s'", mode, parameter, n->second);
		}
	}
	else
	{
		if (n != custom_mode_params.end())
		{
			free(n->second);
			custom_mode_params.erase(n);
		}
	}
}

bool chanrec::IsModeSet(char mode)
{
	return modes[mode-65];
}

std::string chanrec::GetModeParameter(char mode)
{
	if (mode == 'k')
	{
		return this->key;
	}
	else if (mode == 'l')
	{
		return ConvToStr(this->limit);
	}
	else
	{
		CustomModeList::iterator n = custom_mode_params.find(mode);
		if (n != custom_mode_params.end())
		{
			return n->second;
		}
		return "";
	}
}

long chanrec::GetUserCounter()
{
	return (this->internal_userlist.size());
}

void chanrec::AddUser(userrec* user)
{
	internal_userlist[user] = user;
}

unsigned long chanrec::DelUser(userrec* user)
{
	CUList::iterator a = internal_userlist.find(user);
	if (a != internal_userlist.end())
	{
		internal_userlist.erase(a);
		/* And tidy any others... */
		DelOppedUser(user);
		DelHalfoppedUser(user);
		DelVoicedUser(user);
		return internal_userlist.size();
	}
	return internal_userlist.size();
}

bool chanrec::HasUser(userrec* user)
{
	return (internal_userlist.find(user) != internal_userlist.end());
}

void chanrec::AddOppedUser(userrec* user)
{
	internal_op_userlist[user] = user;
}

void chanrec::DelOppedUser(userrec* user)
{
	CUList::iterator a = internal_op_userlist.find(user);
	if (a != internal_op_userlist.end())
	{
		internal_op_userlist.erase(a);
		return;
	}
}

void chanrec::AddHalfoppedUser(userrec* user)
{
	internal_halfop_userlist[user] = user;
}

void chanrec::DelHalfoppedUser(userrec* user)
{
	CUList::iterator a = internal_halfop_userlist.find(user);
	if (a != internal_halfop_userlist.end())
	{   
		internal_halfop_userlist.erase(a);
		return; 
	}
}

void chanrec::AddVoicedUser(userrec* user)
{
	internal_voice_userlist[user] = user;
}

void chanrec::DelVoicedUser(userrec* user)
{
	CUList::iterator a = internal_voice_userlist.find(user);
	if (a != internal_voice_userlist.end())
	{
		internal_voice_userlist.erase(a);
		return; 
	}
}

CUList* chanrec::GetUsers()
{
	return &internal_userlist;
}

CUList* chanrec::GetOppedUsers()
{
	return &internal_op_userlist;
}

CUList* chanrec::GetHalfoppedUsers()
{
	return &internal_halfop_userlist;
}

CUList* chanrec::GetVoicedUsers()
{
	return &internal_voice_userlist;
}

/* 
 * add a channel to a user, creating the record for it if needed and linking
 * it to the user record 
 */

chanrec* add_channel(userrec *user, const char* cn, const char* key, bool override)
{
	if ((!user) || (!cn))
	{
		log(DEFAULT,"*** BUG *** add_channel was given an invalid parameter");
		return 0;
	}

	int created = 0;
	char cname[MAXBUF];
	int MOD_RESULT = 0;
	strlcpy(cname,cn,CHANMAX);
	log(DEBUG,"cname='%s' cn='%s'",cname,cn);

	log(DEBUG,"add_channel: %s %s",user->nick,cname);

	chanrec* Ptr = FindChan(cname);

	if (!Ptr)
	{
		if (user->fd > -1)
		{
			MOD_RESULT = 0;
			FOREACH_RESULT(I_OnUserPreJoin,OnUserPreJoin(user,NULL,cname));
			if (MOD_RESULT == 1)
				return NULL;
		}

		/* create a new one */
		chanlist[cname] = new chanrec();
		strlcpy(chanlist[cname]->name, cname,CHANMAX);
		chanlist[cname]->modes[CM_TOPICLOCK] = chanlist[cname]->modes[CM_NOEXTERNAL] = 1;
		//chanlist[cname]->binarymodes = CM_TOPICLOCK | CM_NOEXTERNAL;
		chanlist[cname]->created = TIME;
		*chanlist[cname]->topic = 0;
		strlcpy(chanlist[cname]->setby, user->nick,NICKMAX-1);
		chanlist[cname]->topicset = 0;
		Ptr = chanlist[cname];
		log(DEBUG,"add_channel: created: %s",cname);
		/*
		 * set created to 2 to indicate user
		 * is the first in the channel
		 * and should be given ops
		 */
		created = 2;
	}
	else
	{
		/* Already on the channel */
		if (Ptr->HasUser(user))
			return NULL;

		/*
		 * remote users are allowed us to bypass channel modes
		 * and bans (used by servers)
		 */
		if (IS_LOCAL(user)) /* was a check on fd > -1 */
		{
			MOD_RESULT = 0;
			FOREACH_RESULT(I_OnUserPreJoin,OnUserPreJoin(user,Ptr,cname));
			if (MOD_RESULT == 1)
			{
				return NULL;
			}
			else if (MOD_RESULT == 0)
			{
				if (*Ptr->key)
				{
					MOD_RESULT = 0;
					FOREACH_RESULT(I_OnCheckKey,OnCheckKey(user, Ptr, key ? key : ""));
					if (!MOD_RESULT)
					{
						if (!key)
						{
							log(DEBUG,"add_channel: no key given in JOIN");
							WriteServ(user->fd,"475 %s %s :Cannot join channel (Requires key)",user->nick, Ptr->name);
							return NULL;
						}
						else
						{
							if (strcmp(key,Ptr->key))
							{
								log(DEBUG,"add_channel: bad key given in JOIN");
								WriteServ(user->fd,"475 %s %s :Cannot join channel (Incorrect key)",user->nick, Ptr->name);
								return NULL;
							}
						}
					}
				}
				if (Ptr->modes[CM_INVITEONLY])
				{
					MOD_RESULT = 0;
					irc::string xname(Ptr->name);
					FOREACH_RESULT(I_OnCheckInvite,OnCheckInvite(user, Ptr));
					if (!MOD_RESULT)
					{
						log(DEBUG,"add_channel: channel is +i");
						if (user->IsInvited(xname))
						{
							/* user was invited to channel */
							/* there may be an optional channel NOTICE here */
						}
						else
						{
							WriteServ(user->fd,"473 %s %s :Cannot join channel (Invite only)",user->nick, Ptr->name);
							return NULL;
						}
					}
					user->RemoveInvite(xname);
				}
				if (Ptr->limit)
				{
					MOD_RESULT = 0;
					FOREACH_RESULT(I_OnCheckLimit,OnCheckLimit(user, Ptr));
					if (!MOD_RESULT)
					{
						if (usercount(Ptr) >= Ptr->limit)
						{
							WriteServ(user->fd,"471 %s %s :Cannot join channel (Channel is full)",user->nick, Ptr->name);
							return NULL;
						}
					}
				}
				if (Ptr->bans.size())
				{
					log(DEBUG,"add_channel: about to walk banlist");
					MOD_RESULT = 0;
					FOREACH_RESULT(I_OnCheckBan,OnCheckBan(user, Ptr));
					if (!MOD_RESULT)
					{
						for (BanList::iterator i = Ptr->bans.begin(); i != Ptr->bans.end(); i++)
						{
							if ((match(user->GetFullHost(),i->data)) || (match(user->GetFullRealHost(),i->data)) || (match((char*)inet_ntoa(user->ip4),i->data)))
							{
								WriteServ(user->fd,"474 %s %s :Cannot join channel (You're banned)",user->nick, Ptr->name);
								return NULL;
							}
						}
					}
				}
			}
		}
		else
		{
			log(DEBUG,"Overridden checks");
		}
		created = 1;
	}

	log(DEBUG,"Passed channel checks");

	for (std::vector<ucrec*>::const_iterator index = user->chans.begin(); index != user->chans.end(); index++)
	{
		if ((*index)->channel == NULL)
		{
			return ForceChan(Ptr, *index, user, created);
		}
	}

	/*
	 * XXX: If the user is an oper here, we can just extend their user->chans vector by one
	 * and put the channel in here. Same for remote users which are not bound by
	 * the channel limits. Otherwise, nope, youre boned.
	 */
	if (!IS_LOCAL(user)) /* was a check on fd < 0 */
	{
		ucrec* a = new ucrec();
		chanrec* c = ForceChan(Ptr,a,user,created);
		user->chans.push_back(a);
		return c;
	}
	else if (*user->oper)
	{
		/* Oper allows extension up to the OPERMAXCHANS value */
		if (user->chans.size() < OPERMAXCHANS)
		{
			ucrec* a = new ucrec();
			chanrec* c = ForceChan(Ptr,a,user,created);
			user->chans.push_back(a);
			return c;
		}
	}

	log(DEBUG,"add_channel: user channel max exceeded: %s %s",user->nick,cname);
	WriteServ(user->fd,"405 %s %s :You are on too many channels",user->nick, cname);

	if (created == 2)
	{
		log(DEBUG,"BLAMMO, Whacking channel.");
		/* Things went seriously pear shaped, so take this away. bwahaha. */
		chan_hash::iterator n = chanlist.find(cname);
		if (n != chanlist.end())
		{
			Ptr->DelUser(user);
			delete Ptr;
			chanlist.erase(n);
			for (unsigned int index =0; index < user->chans.size(); index++)
			{
				if (user->chans[index]->channel == Ptr)
				{
					user->chans[index]->channel = NULL;
					user->chans[index]->uc_modes = 0;	
				}
			}
		}
	}
	return NULL;
}

chanrec* ForceChan(chanrec* Ptr,ucrec *a,userrec* user, int created)
{
	if (created == 2)
	{
		/* first user in is given ops */
		a->uc_modes = UCMODE_OP;
		Ptr->AddOppedUser(user);
	}
	else
	{
		a->uc_modes = 0;
	}

	a->channel = Ptr;
	Ptr->AddUser(user);
	WriteChannel(Ptr,user,"JOIN :%s",Ptr->name);

	/* Major improvement by Brain - we dont need to be calculating all this pointlessly for remote users */
	if (IS_LOCAL(user))
	{
		log(DEBUG,"Sent JOIN to client");
		if (Ptr->topicset)
		{
			WriteServ(user->fd,"332 %s %s :%s", user->nick, Ptr->name, Ptr->topic);
			WriteServ(user->fd,"333 %s %s %s %lu", user->nick, Ptr->name, Ptr->setby, (unsigned long)Ptr->topicset);
		}
		userlist(user,Ptr);
		WriteServ(user->fd,"366 %s %s :End of /NAMES list.", user->nick, Ptr->name);
	}
	FOREACH_MOD(I_OnUserJoin,OnUserJoin(user,Ptr));
	return Ptr;
}

/*
 *remove a channel from a users record, and remove the record from memory
 * if the channel has become empty
 */

chanrec* del_channel(userrec *user, const char* cname, const char* reason, bool local)
{
	if ((!user) || (!cname))
	{
		log(DEFAULT,"*** BUG *** del_channel was given an invalid parameter");
		return NULL;
	}

	chanrec* Ptr = FindChan(cname);

	if (!Ptr)
		return NULL;

	log(DEBUG,"del_channel: removing: %s %s",user->nick,Ptr->name);

	for (unsigned int i =0; i < user->chans.size(); i++)
	{
		/* zap it from the channel list of the user */
		if (user->chans[i]->channel == Ptr)
		{
			if (reason)
			{
				FOREACH_MOD(I_OnUserPart,OnUserPart(user,Ptr,reason));
				WriteChannel(Ptr,user,"PART %s :%s",Ptr->name, reason);
			}
			else
			{
				FOREACH_MOD(I_OnUserPart,OnUserPart(user,Ptr,""));
				WriteChannel(Ptr,user,"PART :%s",Ptr->name);
			}
			user->chans[i]->uc_modes = 0;
			user->chans[i]->channel = NULL;
			log(DEBUG,"del_channel: unlinked: %s %s",user->nick,Ptr->name);
			break;
		}
	}

	Ptr->DelUser(user);

	/* if there are no users left on the channel */
	if (!usercount(Ptr))
	{
		chan_hash::iterator iter = chanlist.find(Ptr->name);

		log(DEBUG,"del_channel: destroying channel: %s",Ptr->name);

		/* kill the record */
		if (iter != chanlist.end())
		{
			log(DEBUG,"del_channel: destroyed: %s",Ptr->name);
			FOREACH_MOD(I_OnChannelDelete,OnChannelDelete(Ptr));
			delete Ptr;
			chanlist.erase(iter);
		}
	}

	return NULL;
}

void server_kick_channel(userrec* user, chanrec* Ptr, char* reason, bool triggerevents)
{
	if ((!user) || (!Ptr) || (!reason))
	{
		return;
	}

	if (IS_LOCAL(user))
	{
		if (!Ptr->HasUser(user))
		{
			/* Not on channel */
			return;
		}
	}
	
	if (triggerevents)
	{
		FOREACH_MOD(I_OnUserKick,OnUserKick(NULL,user,Ptr,reason));
	}

	for (unsigned int i =0; i < user->chans.size(); i++)
	{
		if ((user->chans[i]->channel) && (user->chans[i]->channel == Ptr))
		{
			WriteChannelWithServ(Config->ServerName,Ptr,"KICK %s %s :%s",Ptr->name, user->nick, reason);
			user->chans[i]->uc_modes = 0;
			user->chans[i]->channel = NULL;
			break;
		}
	}

	Ptr->DelUser(user);

	if (!usercount(Ptr))
	{
		chan_hash::iterator iter = chanlist.find(Ptr->name);
		log(DEBUG,"del_channel: destroying channel: %s",Ptr->name);
		/* kill the record */
		if (iter != chanlist.end())
		{
			log(DEBUG,"del_channel: destroyed: %s",Ptr->name);
		   	FOREACH_MOD(I_OnChannelDelete,OnChannelDelete(Ptr));
			delete Ptr;
			chanlist.erase(iter);
		}
	}
}

void kick_channel(userrec *src,userrec *user, chanrec *Ptr, char* reason)
{
	if ((!src) || (!user) || (!Ptr) || (!reason))
	{
		log(DEFAULT,"*** BUG *** kick_channel was given an invalid parameter");
		return;
	}

	log(DEBUG,"kick_channel: removing: %s %s %s",user->nick,Ptr->name,src->nick);

	if (IS_LOCAL(src))
	{
		if (!Ptr->HasUser(user))
		{
			WriteServ(src->fd,"441 %s %s %s :They are not on that channel",src->nick, user->nick, Ptr->name);
			return;
		}
		int MOD_RESULT = 0;

		if (!is_uline(src->server))
		{
			MOD_RESULT = 0;
			FOREACH_RESULT(I_OnUserPreKick,OnUserPreKick(src,user,Ptr,reason));
			if (MOD_RESULT == 1)
				return;
		}
		/* Set to -1 by OnUserPreKick if explicit allow was set */
		if (MOD_RESULT != -1)
		{
			FOREACH_RESULT(I_OnAccessCheck,OnAccessCheck(src,user,Ptr,AC_KICK));
			if ((MOD_RESULT == ACR_DENY) && (!is_uline(src->server)))
				return;
	
			if ((MOD_RESULT == ACR_DEFAULT) || (!is_uline(src->server)))
			{
   			 	if ((cstatus(src,Ptr) < STATUS_HOP) || (cstatus(src,Ptr) < cstatus(user,Ptr)))
				{
					if (cstatus(src,Ptr) == STATUS_HOP)
					{
						WriteServ(src->fd,"482 %s %s :You must be a channel operator",src->nick, Ptr->name);
					}
					else
					{
						WriteServ(src->fd,"482 %s %s :You must be at least a half-operator",src->nick, Ptr->name);
					}
		
					return;
				}
			}
		}
	}

	FOREACH_MOD(I_OnUserKick,OnUserKick(src,user,Ptr,reason));
			
	for (std::vector<ucrec*>::const_iterator i = user->chans.begin(); i != user->chans.end(); i++)
	{
		/* zap it from the channel list of the user */
		if ((*i)->channel && ((*i)->channel == Ptr))
		{
			WriteChannel(Ptr,src,"KICK %s %s :%s",Ptr->name, user->nick, reason);
			(*i)->uc_modes = 0;
			(*i)->channel = NULL;
			log(DEBUG,"del_channel: unlinked: %s %s",user->nick,Ptr->name);
			break;
		}
	}

	if (!Ptr->DelUser(user))
	/* if there are no users left on the channel */
	{
		chan_hash::iterator iter = chanlist.find(Ptr->name);

		log(DEBUG,"del_channel: destroying channel: %s",Ptr->name);

		/* kill the record */
		if (iter != chanlist.end())
		{
			log(DEBUG,"del_channel: destroyed: %s",Ptr->name);
			FOREACH_MOD(I_OnChannelDelete,OnChannelDelete(Ptr));
			delete Ptr;
			chanlist.erase(iter);
		}
	}
}