Merge pull request #1 from HerculesWS/master

Update from original

1 files changed, 181 insertions, 135 deletions

diff --git a/src/map/chat.c b/src/map/chat.c
index c0452f2c5..cd7b5f811 100644
--- a/src/map/chat.c
+++ b/src/map/chat.c
@@ -1,12 +1,14 @@
-// Copyright (c) Athena Dev Teams - Licensed under GNU GPL
-// For more information, see LICENCE in the main folder
+// Copyright (c) Hercules Dev Team, licensed under GNU GPL.
+// See the LICENSE file
+// Portions Copyright (c) Athena Dev Teams
+
+#define HERCULES_CORE
+
+#include "chat.h"
+
+#include <stdio.h>
+#include <string.h>
 
-#include "../common/cbasetypes.h"
-#include "../common/malloc.h"
-#include "../common/nullpo.h"
-#include "../common/showmsg.h"
-#include "../common/strlib.h"
-#include "../common/mmo.h"
 #include "atcommand.h" // msg_txt()
 #include "battle.h" // struct battle_config
 #include "clif.h"
@@ -14,21 +16,23 @@
 #include "npc.h" // npc_event_do()
 #include "pc.h"
 #include "skill.h" // ext_skill_unit_onplace()
-#include "chat.h"
-
-#include <stdio.h>
-#include <string.h>
-
+#include "../common/cbasetypes.h"
+#include "../common/malloc.h"
+#include "../common/mmo.h"
+#include "../common/nullpo.h"
+#include "../common/showmsg.h"
+#include "../common/strlib.h"
 
-int chat_triggerevent(struct chat_data *cd); // forward declaration
+struct chat_interface chat_s;
 
 /// Initializes a chatroom object (common functionality for both pc and npc chatrooms).
 /// Returns a chatroom object on success, or NULL on failure.
-static struct chat_data* chat_createchat(struct block_list* bl, const char* title, const char* pass, int limit, bool pub, int trigger, const char* ev, int zeny, int minLvl, int maxLvl)
+struct chat_data* chat_createchat(struct block_list* bl, const char* title, const char* pass, int limit, bool pub, int trigger, const char* ev, int zeny, int minLvl, int maxLvl)
 {
 	struct chat_data* cd;
 	nullpo_retr(NULL, bl);
 
+	/* Given the overhead and the numerous instances (npc allocated or otherwise) wouldn't it be beneficial to have it use ERS? [Ind] */
 	cd = (struct chat_data *) aMalloc(sizeof(struct chat_data));
 
 	safestrncpy(cd->title, title, sizeof(cd->title));
@@ -44,21 +48,20 @@ static struct chat_data* chat_createchat(struct block_list* bl, const char* titl
 	cd->owner = bl;
 	safestrncpy(cd->npc_event, ev, sizeof(cd->npc_event));
 
-	cd->bl.id   = iMap->get_new_object_id();
+	cd->bl.id   = map->get_new_object_id();
 	cd->bl.m    = bl->m;
 	cd->bl.x    = bl->x;
 	cd->bl.y    = bl->y;
 	cd->bl.type = BL_CHAT;
 	cd->bl.next = cd->bl.prev = NULL;
 
-	if( cd->bl.id == 0 )
-	{
+	if( cd->bl.id == 0 ) {
 		aFree(cd);
-		cd = NULL;
+		return NULL;
 	}
 
-	iMap->addiddb(&cd->bl);
-
+	map->addiddb(&cd->bl);
+	
 	if( bl->type != BL_NPC )
 		cd->kick_list = idb_alloc(DB_OPT_BASE);
 	
@@ -68,34 +71,31 @@ static struct chat_data* chat_createchat(struct block_list* bl, const char* titl
 /*==========================================
  * player chatroom creation
  *------------------------------------------*/
-int chat_createpcchat(struct map_session_data* sd, const char* title, const char* pass, int limit, bool pub)
-{
+bool chat_createpcchat(struct map_session_data* sd, const char* title, const char* pass, int limit, bool pub) {
 	struct chat_data* cd;
 	nullpo_ret(sd);
 
 	if( sd->chatID )
-		return 0; //Prevent people abusing the chat system by creating multiple chats, as pointed out by End of Exam. [Skotlex]
+		return false; //Prevent people abusing the chat system by creating multiple chats, as pointed out by End of Exam. [Skotlex]
 
 	if( sd->state.vending || sd->state.buyingstore )
 	{// not chat, when you already have a store open
-		return 0;
+		return false;
 	}
 
-	if( map[sd->bl.m].flag.nochat )
-	{
+	if( map->list[sd->bl.m].flag.nochat ) {
 		clif->message(sd->fd, msg_txt(281));
-		return 0; //Can't create chatrooms on this map.
+		return false; //Can't create chatrooms on this map.
 	}
 
-	if( iMap->getcell(sd->bl.m,sd->bl.x,sd->bl.y,CELL_CHKNOCHAT) )
-	{
-		clif->message (sd->fd, msg_txt(665));
-		return 0;
+	if( map->getcell(sd->bl.m,sd->bl.x,sd->bl.y,CELL_CHKNOCHAT) ) {
+		clif->message (sd->fd, msg_txt(865)); // "Can't create chat rooms in this area."
+		return false;
 	}
 
 	pc_stop_walking(sd,1);
 
-	cd = chat_createchat(&sd->bl, title, pass, limit, pub, 0, "", 0, 1, MAX_LEVEL);
+	cd = chat->create(&sd->bl, title, pass, limit, pub, 0, "", 0, 1, MAX_LEVEL);
 	if( cd ) {
 		cd->users = 1;
 		cd->usersd[0] = sd;
@@ -103,51 +103,51 @@ int chat_createpcchat(struct map_session_data* sd, const char* title, const char
 		pc_stop_attack(sd);
 		clif->createchat(sd,0);
 		clif->dispchat(cd,0);
-	} else
-		clif->createchat(sd,1);
+		return true;
+	}
+	clif->createchat(sd,1); // 1 = Room limit exceeded
 
-	return 0;
+	return false;
 }
 
 /*==========================================
  * join an existing chatroom
  *------------------------------------------*/
-int chat_joinchat(struct map_session_data* sd, int chatid, const char* pass)
-{
+bool chat_joinchat(struct map_session_data* sd, int chatid, const char* pass) {
 	struct chat_data* cd;
 
 	nullpo_ret(sd);
-	cd = (struct chat_data*)iMap->id2bl(chatid);
+	cd = (struct chat_data*)map->id2bl(chatid);
 
 	if( cd == NULL || cd->bl.type != BL_CHAT || cd->bl.m != sd->bl.m || sd->state.vending || sd->state.buyingstore || sd->chatID || ((cd->owner->type == BL_NPC) ? cd->users+1 : cd->users) >= cd->limit )
 	{
-		clif->joinchatfail(sd,0);
-		return 0;
+		clif->joinchatfail(sd,0); // room full
+		return false;
 	}
 
 	if( !cd->pub && strncmp(pass, cd->pass, sizeof(cd->pass)) != 0 && !pc_has_permission(sd, PC_PERM_JOIN_ALL_CHAT) )
 	{
-		clif->joinchatfail(sd,1);
-		return 0;
+		clif->joinchatfail(sd,1); // wrong password
+		return false;
 	}
 
 	if( sd->status.base_level < cd->minLvl || sd->status.base_level > cd->maxLvl ) {
 		if(sd->status.base_level < cd->minLvl)
-			clif->joinchatfail(sd,5);
+			clif->joinchatfail(sd,5); // too low level
 		else
-			clif->joinchatfail(sd,6);
+			clif->joinchatfail(sd,6); // too high level
 
-		return 0;
+		return false;
 	}
 
 	if( sd->status.zeny < cd->zeny ) {
-		clif->joinchatfail(sd,4);
-		return 0;
+		clif->joinchatfail(sd,4); // not enough zeny
+		return false;
 	}
 
 	if( cd->owner->type != BL_NPC && idb_exists(cd->kick_list,sd->status.char_id) ) {
-		clif->joinchatfail(sd,2);//You have been kicked out of the room.
-		return 0;
+		clif->joinchatfail(sd,2); // You have been kicked out of the room.
+		return false;
 	}
 
 	pc_stop_walking(sd,1);
@@ -157,38 +157,41 @@ int chat_joinchat(struct map_session_data* sd, int chatid, const char* pass)
 	pc_setchatid(sd,cd->bl.id);
 
     clif->joinchatok(sd, cd); //To the person who newly joined the list of all
-    clif->addchat(cd, sd); //Reports To the person who already in the chat 
-    clif->dispchat(cd, 0); //Reported number of changes to the people around 
+    clif->addchat(cd, sd); //Reports To the person who already in the chat
+    clif->dispchat(cd, 0); //Reported number of changes to the people around
 
-    chat_triggerevent(cd); //Event 
+    chat->trigger_event(cd); //Event
 
-    return 0;
+    return true;
 }
 
 
 /*==========================================
- * leave a chatroom
+ * Leave a chatroom
+ * Return
+ *	0: User not found in chatroom/Missing data
+ *  1: Success
+ *  2: Chat room deleted (chat room empty)
+ *  3: Owner changed (Owner left and a new one as assigned)
  *------------------------------------------*/
-int chat_leavechat(struct map_session_data* sd, bool kicked)
-{
+int chat_leavechat(struct map_session_data* sd, bool kicked) {
 	struct chat_data* cd;
 	int i;
 	int leavechar;
 
-	nullpo_retr(1, sd);
+	nullpo_retr(0, sd);
 
-	cd = (struct chat_data*)iMap->id2bl(sd->chatID);
-	if( cd == NULL )
-	{
+	cd = (struct chat_data*)map->id2bl(sd->chatID);
+	if( cd == NULL ) {
 		pc_setchatid(sd, 0);
-		return 1;
+		return 0;
 	}
 
 	ARR_FIND( 0, cd->users, i, cd->usersd[i] == sd );
 	if ( i == cd->users )
 	{	// Not found in the chatroom?
 		pc_setchatid(sd, 0);
-		return -1;
+		return 0;
 	}
 
 	clif->leavechat(cd, sd, kicked);
@@ -202,61 +205,63 @@ int chat_leavechat(struct map_session_data* sd, bool kicked)
 
 
 	if( cd->users == 0 && cd->owner->type == BL_PC ) { // Delete empty chatroom
-		struct skill_unit* unit;
-		struct skill_unit_group* group;	
+		struct skill_unit* su;
+		struct skill_unit_group* group;
 
 		clif->clearchat(cd, 0);
 		db_destroy(cd->kick_list);
-		iMap->deliddb(&cd->bl);
-		iMap->delblock(&cd->bl);
-		iMap->freeblock(&cd->bl);
+		map->deliddb(&cd->bl);
+		map->delblock(&cd->bl);
+		map->freeblock(&cd->bl);
 		
-		unit = iMap->find_skill_unit_oncell(&sd->bl, sd->bl.x, sd->bl.y, AL_WARP, NULL, 0);
-		group = (unit != NULL) ? unit->group : NULL;
+		su = map->find_skill_unit_oncell(&sd->bl, sd->bl.x, sd->bl.y, AL_WARP, NULL, 0);
+		group = (su != NULL) ? su->group : NULL;
 		if (group != NULL)
-			skill->unit_onplace(unit, &sd->bl, group->tick);
+			skill->unit_onplace(su, &sd->bl, group->tick);
 
-		return 1;
+		return 2;
 	}
 
-	if( leavechar == 0 && cd->owner->type == BL_PC )
-	{	// Set and announce new owner
+	if( leavechar == 0 && cd->owner->type == BL_PC ) {
+		// Set and announce new owner
 		cd->owner = (struct block_list*) cd->usersd[0];
 		clif->changechatowner(cd, cd->usersd[0]);
 		clif->clearchat(cd, 0);
 
 		//Adjust Chat location after owner has been changed.
-		iMap->delblock( &cd->bl );
+		map->delblock( &cd->bl );
 		cd->bl.x=cd->usersd[0]->bl.x;
 		cd->bl.y=cd->usersd[0]->bl.y;
-		iMap->addblock( &cd->bl );
+		map->addblock( &cd->bl );
 
 		clif->dispchat(cd,0);
+		return 3; // Owner changed
 	}
-	else
-		clif->dispchat(cd,0); // refresh chatroom
+	clif->dispchat(cd,0); // refresh chatroom
 
-	return 0;
+	return 1;
 }
 
 /*==========================================
- * change a chatroom's owner
+ * Change a chatroom's owner
+ * Return
+ *  0: User not found/Missing data
+ *  1: Success
  *------------------------------------------*/
-int chat_changechatowner(struct map_session_data* sd, const char* nextownername)
-{
+bool chat_changechatowner(struct map_session_data* sd, const char* nextownername) {
 	struct chat_data* cd;
 	struct map_session_data* tmpsd;
 	int i;
 
-	nullpo_retr(1, sd);
+	nullpo_ret(sd);
 
-	cd = (struct chat_data*)iMap->id2bl(sd->chatID);
+	cd = (struct chat_data*)map->id2bl(sd->chatID);
 	if( cd == NULL || (struct block_list*) sd != cd->owner )
-		return 1;
+		return false;
 
 	ARR_FIND( 1, cd->users, i, strncmp(cd->usersd[i]->status.name, nextownername, NAME_LENGTH) == 0 );
 	if( i == cd->users )
-		return -1;  // name not found
+		return false;  // name not found
 
 	// erase temporarily
 	clif->clearchat(cd,0);
@@ -271,29 +276,31 @@ int chat_changechatowner(struct map_session_data* sd, const char* nextownername)
 	cd->usersd[0] = tmpsd;
 
 	// set the new chatroom position
-	iMap->delblock( &cd->bl );
+	map->delblock( &cd->bl );
 	cd->bl.x = cd->owner->x;
 	cd->bl.y = cd->owner->y;
-	iMap->addblock( &cd->bl );
+	map->addblock( &cd->bl );
 
 	// and display again
 	clif->dispchat(cd,0);
 
-	return 0;
+	return true;
 }
 
 /*==========================================
- * change a chatroom's status (title, etc)
+ * Change a chatroom's status (title, etc)
+ * Return
+ *  0: Missing data
+ *  1: Success
  *------------------------------------------*/
-int chat_changechatstatus(struct map_session_data* sd, const char* title, const char* pass, int limit, bool pub)
-{
+bool chat_changechatstatus(struct map_session_data* sd, const char* title, const char* pass, int limit, bool pub) {
 	struct chat_data* cd;
 
-	nullpo_retr(1, sd);
+	nullpo_ret(sd);
 
-	cd = (struct chat_data*)iMap->id2bl(sd->chatID);
+	cd = (struct chat_data*)map->id2bl(sd->chatID);
 	if( cd==NULL || (struct block_list *)sd != cd->owner )
-		return 1;
+		return false;
 
 	safestrncpy(cd->title, title, CHATROOM_TITLE_SIZE);
 	safestrncpy(cd->pass, pass, CHATROOM_PASS_SIZE);
@@ -303,122 +310,161 @@ int chat_changechatstatus(struct map_session_data* sd, const char* title, const
 	clif->changechatstatus(cd);
 	clif->dispchat(cd,0);
 
-	return 0;
+	return true;
 }
 
 /*==========================================
- * kick an user from a chatroom
+ * Kick an user from a chatroom
+ * Return:
+ *  0: User cannot be kicked (is gm)/Missing data
+ *  1: Success
  *------------------------------------------*/
-int chat_kickchat(struct map_session_data* sd, const char* kickusername)
-{
+bool chat_kickchat(struct map_session_data* sd, const char* kickusername) {
 	struct chat_data* cd;
 	int i;
 
-	nullpo_retr(1, sd);
+	nullpo_ret(sd);
 
-	cd = (struct chat_data *)iMap->id2bl(sd->chatID);
+	cd = (struct chat_data *)map->id2bl(sd->chatID);
 	
 	if( cd==NULL || (struct block_list *)sd != cd->owner )
-		return -1;
+		return false;
 
 	ARR_FIND( 0, cd->users, i, strncmp(cd->usersd[i]->status.name, kickusername, NAME_LENGTH) == 0 );
-	if( i == cd->users )
-		return -1;
+	if( i == cd->users ) // User not found
+		return false;
 
 	if (pc_has_permission(cd->usersd[i], PC_PERM_NO_CHAT_KICK))
-		return 0; //gm kick protection [Valaris]
+		return false; //gm kick protection [Valaris]
 	
-	idb_put(cd->kick_list,cd->usersd[i]->status.char_id,(void*)1);
+	idb_iput(cd->kick_list,cd->usersd[i]->status.char_id,1);
 
-	chat_leavechat(cd->usersd[i],1);
-	return 0;
+	chat->leave(cd->usersd[i],1);
+	return true;
 }
 
-/// Creates a chat room for the npc.
-int chat_createnpcchat(struct npc_data* nd, const char* title, int limit, bool pub, int trigger, const char* ev, int zeny, int minLvl, int maxLvl)
+/*==========================================
+ * Creates a chat room for the npc
+ *------------------------------------------*/
+bool chat_createnpcchat(struct npc_data* nd, const char* title, int limit, bool pub, int trigger, const char* ev, int zeny, int minLvl, int maxLvl)
 {
 	struct chat_data* cd;
 	nullpo_ret(nd);
 
 	if( nd->chat_id ) {
 		ShowError("chat_createnpcchat: npc '%s' already has a chatroom, cannot create new one!\n", nd->exname);
-		return 0;
+		return false;
 	}
 
 	if( zeny > MAX_ZENY || maxLvl > MAX_LEVEL ) {
 		ShowError("chat_createnpcchat: npc '%s' has a required lvl or amount of zeny over the max limit!\n", nd->exname);
-		return 0;
+		return false;
 	}
 
-	cd = chat_createchat(&nd->bl, title, "", limit, pub, trigger, ev, zeny, minLvl, maxLvl);
+	cd = chat->create(&nd->bl, title, "", limit, pub, trigger, ev, zeny, minLvl, maxLvl);
 
 	if( cd ) {
 		nd->chat_id = cd->bl.id;
 		clif->dispchat(cd,0);
+		return true;
 	}
 
-	return 0;
+	return false;
 }
 
-/// Removes the chatroom from the npc.
-int chat_deletenpcchat(struct npc_data* nd)
-{
+/*==========================================
+ * Removes the chatroom from the npc.
+ * Return:
+ *  0: Missing data
+ *  1: Success
+ *------------------------------------------*/
+bool chat_deletenpcchat(struct npc_data* nd) {
 	struct chat_data *cd;
 	nullpo_ret(nd);
 
-	cd = (struct chat_data*)iMap->id2bl(nd->chat_id);
+	cd = (struct chat_data*)map->id2bl(nd->chat_id);
 	if( cd == NULL )
-		return 0;
+		return false;
 	
-	chat_npckickall(cd);
+	chat->npc_kick_all(cd);
 	clif->clearchat(cd, 0);
-	iMap->deliddb(&cd->bl);
-	iMap->delblock(&cd->bl);
-	iMap->freeblock(&cd->bl);
+	map->deliddb(&cd->bl);
+	map->delblock(&cd->bl);
+	map->freeblock(&cd->bl);
 	nd->chat_id = 0;
 	
-	return 0;
+	return true;
 }
 
 /*==========================================
  * Trigger npc event when we enter the chatroom
+ * Return
+ *  0: Couldn't trigger / Missing data
+ *  1: Success
  *------------------------------------------*/
-int chat_triggerevent(struct chat_data *cd)
+bool chat_triggerevent(struct chat_data *cd)
 {
 	nullpo_ret(cd);
 
 	if( cd->users >= cd->trigger && cd->npc_event[0] )
-		npc_event_do(cd->npc_event);
-	return 0;
+	{
+		npc->event_do(cd->npc_event);
+		return true;
+	}
+	return false;
 }
 
 /// Enables the event of the chat room.
 /// At most, 127 users are needed to trigger the event.
-int chat_enableevent(struct chat_data* cd)
+bool chat_enableevent(struct chat_data* cd)
 {
 	nullpo_ret(cd);
 
 	cd->trigger &= 0x7f;
-	chat_triggerevent(cd);
-	return 0;
+	chat->trigger_event(cd);
+	return true;
 }
 
 /// Disables the event of the chat room
-int chat_disableevent(struct chat_data* cd)
+bool chat_disableevent(struct chat_data* cd)
 {
 	nullpo_ret(cd);
 
 	cd->trigger |= 0x80;
-	return 0;
+	return true;
 }
 
 /// Kicks all the users from the chat room.
-int chat_npckickall(struct chat_data* cd)
+bool chat_npckickall(struct chat_data* cd)
 {
 	nullpo_ret(cd);
 
 	while( cd->users > 0 )
-		chat_leavechat(cd->usersd[cd->users-1],0);
+		chat->leave(cd->usersd[cd->users-1],0);
 
-	return 0;
+	return true;
+}
+
+/*=====================================
+* Default Functions : chat.h
+* Generated by HerculesInterfaceMaker
+* created by Susu
+*-------------------------------------*/
+void chat_defaults(void) {
+	chat = &chat_s;
+	
+	/* funcs */
+	chat->create_pc_chat = chat_createpcchat;
+	chat->join = chat_joinchat;
+	chat->leave = chat_leavechat;
+	chat->change_owner = chat_changechatowner;
+	chat->change_status = chat_changechatstatus;
+	chat->kick = chat_kickchat;
+	chat->create_npc_chat = chat_createnpcchat;
+	chat->delete_npc_chat = chat_deletenpcchat;
+	chat->enable_event = chat_enableevent;
+	chat->disable_event = chat_disableevent;
+	chat->npc_kick_all = chat_npckickall;
+	chat->trigger_event = chat_triggerevent;
+	chat->create = chat_createchat;
 }