* Documented/cleaned up chatroom code and packetry

* Added some comments to clif_changechatowner()
- totally broken, see the code + topic:163829
* Implemented the chatroom display packet properly
- now has 4 types: public, private, npc and non-clickable npc chatroom
* Implemented the chatroom leave packet properly
- now utilizes the 'kicked' flag when the user was forced to leave
- TODO: banlist support to prevent re-entry, see jAthena code

git-svn-id: https://rathena.svn.sourceforge.net/svnroot/rathena/trunk@11100 54d463be-8e91-2dee-dedb-b68131a5f0ec

1 files changed, 41 insertions, 34 deletions

diff --git a/src/map/chat.c b/src/map/chat.c
index 1f8166871..0a2b18d37 100644
--- a/src/map/chat.c
+++ b/src/map/chat.c
@@ -32,7 +32,7 @@ static struct chat_data* chat_createchat(struct block_list* bl, const char* titl
 	safestrncpy(cd->pass, pass, sizeof(cd->pass));
 	cd->pub = pub;
 	cd->users = 0;
-	cd->limit = limit;
+	cd->limit = min(limit, ARRAYSIZE(cd->usersd));
 	cd->trigger = trigger;
 	memset(cd->usersd, 0, sizeof(cd->usersd));
 	cd->owner = bl;
@@ -45,7 +45,8 @@ static struct chat_data* chat_createchat(struct block_list* bl, const char* titl
 	cd->bl.next = cd->bl.prev = NULL;
 	cd->bl.id   = map_addobject(&cd->bl);
 
-	if( cd->bl.id == 0 ) {
+	if( cd->bl.id == 0 )
+	{
 		aFree(cd);
 		cd = NULL;
 	}
@@ -61,23 +62,27 @@ int chat_createpcchat(struct map_session_data* sd, const char* title, const char
 	struct chat_data* cd;
 	nullpo_retr(0, sd);
 
-	if (sd->chatID)
+	if( sd->chatID )
 		return 0; //Prevent people abusing the chat system by creating multiple chats, as pointed out by End of Exam. [Skotlex]
 
-	if (map[sd->bl.m].flag.nochat) {
-		clif_displaymessage (sd->fd, msg_txt(281));
+	if( map[sd->bl.m].flag.nochat )
+	{
+		clif_displaymessage(sd->fd, msg_txt(281));
 		return 0; //Can't create chatrooms on this map.
 	}
+
 	pc_stop_walking(sd,1);
 
 	cd = chat_createchat(&sd->bl, title, pass, limit, pub, 0, "");
-	if (cd) {
+	if( cd )
+	{
 		cd->users = 1;
 		cd->usersd[0] = sd;
 		pc_setchatid(sd,cd->bl.id);
 		clif_createchat(sd,0);
 		clif_dispchat(cd,0);
-	} else
+	}
+	else
 		clif_createchat(sd,1);
 
 	return 0;
@@ -93,11 +98,14 @@ int chat_joinchat(struct map_session_data* sd, int chatid, const char* pass)
 	nullpo_retr(0, sd);
 	cd = (struct chat_data*)map_id2bl(chatid);
 
-	if (cd == NULL || cd->bl.type != BL_CHAT || cd->bl.m != sd->bl.m || sd->vender_id || sd->chatID || cd->users >= cd->limit) {
+	if( cd == NULL || cd->bl.type != BL_CHAT || cd->bl.m != sd->bl.m || sd->vender_id || sd->chatID || cd->users >= cd->limit )
+	{
 		clif_joinchatfail(sd,0);
 		return 0;
 	}
-	if (!cd->pub && strncmp(pass, cd->pass, sizeof(cd->pass)) != 0 && !(battle_config.gm_join_chat && pc_isGM(sd) >= battle_config.gm_join_chat)) {
+
+	if( !cd->pub && strncmp(pass, cd->pass, sizeof(cd->pass)) != 0 && !(battle_config.gm_join_chat && pc_isGM(sd) >= battle_config.gm_join_chat) )
+	{
 		clif_joinchatfail(sd,1);
 		return 0;
 	}
@@ -121,7 +129,7 @@ int chat_joinchat(struct map_session_data* sd, int chatid, const char* pass)
 /*==========================================
  * leave a chatroom
  *------------------------------------------*/
-int chat_leavechat(struct map_session_data* sd)
+int chat_leavechat(struct map_session_data* sd, bool kicked)
 {
 	struct chat_data* cd;
 	int i;
@@ -138,23 +146,23 @@ int chat_leavechat(struct map_session_data* sd)
 
 	ARR_FIND( 0, cd->users, i, cd->usersd[i] == sd );
 	if ( i == cd->users )
-	{// Not found in the chatroom?
+	{	// Not found in the chatroom?
 		pc_setchatid(sd, 0);
 		return -1;
 	}
 
 	leavechar = i;
 
-	clif_leavechat(cd, sd);
+	clif_leavechat(cd, sd, kicked);
 
 	for( i = leavechar; i < cd->users; i++ )
-		cd->usersd[i] = cd->usersd[i + 1];
+		cd->usersd[i] = cd->usersd[i+1];
 
 	pc_setchatid(sd, 0);
 	cd->users--;
 
 	if( cd->users == 0 && cd->owner->type == BL_PC )
-	{// Delete empty chatroom
+	{	// Delete empty chatroom
 		clif_clearchat(cd, 0);
 		map_delobject(cd->bl.id);
 		return 1;
@@ -187,29 +195,28 @@ int chat_changechatowner(struct map_session_data* sd, const char* nextownername)
 {
 	struct chat_data* cd;
 	struct map_session_data* tmpsd;
-	int i, nextowner;
+	int i;
 
 	nullpo_retr(1, sd);
 
 	cd = (struct chat_data*)map_id2bl(sd->chatID);
-	if (cd == NULL || (struct block_list*) sd != cd->owner)
+	if( cd == NULL || (struct block_list*) sd != cd->owner )
 		return 1;
 
 	ARR_FIND( 1, cd->users, i, strncmp(cd->usersd[i]->status.name, nextownername, NAME_LENGTH) == 0 );
-	if (i == cd->users)
+	if( i == cd->users )
 		return -1;  // name not found
 
 	// erase temporarily
 	clif_clearchat(cd,0);
 
 	// set new owner
-	nextowner = i;
-	cd->owner = (struct block_list*) cd->usersd[nextowner];
-	clif_changechatowner(cd,cd->usersd[nextowner]);
+	cd->owner = (struct block_list*) cd->usersd[i];
+	clif_changechatowner(cd,cd->usersd[i]);
 
-	// change the owner's position (placing him to 0)
-	tmpsd = cd->usersd[nextowner];
-	cd->usersd[nextowner] = cd->usersd[0];
+	// swap the old and new owners' positions
+	tmpsd = cd->usersd[i];
+	cd->usersd[i] = cd->usersd[0];
 	cd->usersd[0] = tmpsd;
 
 	// set the new chatroom position
@@ -233,13 +240,13 @@ int chat_changechatstatus(struct map_session_data* sd, const char* title, const
 
 	nullpo_retr(1, sd);
 
-	cd=(struct chat_data*)map_id2bl(sd->chatID);
-	if(cd==NULL || (struct block_list *)sd != cd->owner)
+	cd = (struct chat_data*)map_id2bl(sd->chatID);
+	if( cd==NULL || (struct block_list *)sd != cd->owner )
 		return 1;
 
 	safestrncpy(cd->title, title, CHATROOM_TITLE_SIZE);
 	safestrncpy(cd->pass, pass, CHATROOM_PASS_SIZE);
-	cd->limit = limit;
+	cd->limit = min(limit, ARRAYSIZE(cd->usersd));
 	cd->pub = pub;
 
 	clif_changechatstatus(cd);
@@ -260,17 +267,17 @@ int chat_kickchat(struct map_session_data* sd, const char* kickusername)
 
 	cd = (struct chat_data *)map_id2bl(sd->chatID);
 	
-	if (!cd)
+	if( !cd )
 		return -1;
 
 	ARR_FIND( 0, cd->users, i, strncmp(cd->usersd[i]->status.name, kickusername, NAME_LENGTH) == 0 );
-	if (i == cd->users)
+	if( i == cd->users )
 		return -1;
 
-	if (battle_config.gm_kick_chat && pc_isGM(cd->usersd[i]) >= battle_config.gm_kick_chat)
+	if( battle_config.gm_kick_chat && pc_isGM(cd->usersd[i]) >= battle_config.gm_kick_chat )
 		return 0; //gm kick protection [Valaris]
 
-	chat_leavechat(cd->usersd[i]);
+	chat_leavechat(cd->usersd[i],1);
 	return 0;
 }
 
@@ -281,7 +288,7 @@ int chat_createnpcchat(struct npc_data* nd, const char* title, int limit, bool p
 	nullpo_retr(0, nd);
 
 	cd = chat_createchat(&nd->bl, title, "", limit, pub, trigger, ev);
-	if (cd)
+	if( cd )
 	{
 		nd->chat_id = cd->bl.id;
 		clif_dispchat(cd,0);
@@ -296,7 +303,7 @@ int chat_deletenpcchat(struct npc_data* nd)
 	struct chat_data *cd;
 
 	nullpo_retr(0, nd);
-	nullpo_retr(0, cd=(struct chat_data*)map_id2bl(nd->chat_id));
+	nullpo_retr(0, cd = (struct chat_data*)map_id2bl(nd->chat_id));
 	
 	chat_npckickall(cd);
 	clif_clearchat(cd, 0);
@@ -338,13 +345,13 @@ int chat_disableevent(struct chat_data* cd)
 	return 0;
 }
 
-/// Kicks all the users for the chat room.
+/// Kicks all the users from the chat room.
 int chat_npckickall(struct chat_data* cd)
 {
 	nullpo_retr(0, cd);
 
 	while( cd->users > 0 )
-		chat_leavechat(cd->usersd[cd->users-1]);
+		chat_leavechat(cd->usersd[cd->users-1],0);
 
 	return 0;
 }