Rewrite client interface for login server (part 7)

Added private interface in lclif.p.h

Signed-off-by: Haru <haru@dotalux.com>

6 files changed, 278 insertions, 234 deletions

diff --git a/src/login/HPMlogin.c b/src/login/HPMlogin.c
index e3f580341..472cba3c9 100644
--- a/src/login/HPMlogin.c
+++ b/src/login/HPMlogin.c
@@ -26,6 +26,7 @@
 
 #include "login/account.h"
 #include "login/lclif.h"
+#include "login/lclif.p.h"
 #include "login/login.h"
 #include "common/HPMi.h"
 #include "common/conf.h"
diff --git a/src/login/Makefile.in b/src/login/Makefile.in
index 222c87e2a..274a82fc8 100644
--- a/src/login/Makefile.in
+++ b/src/login/Makefile.in
@@ -43,7 +43,7 @@ MT19937AR_H = $(MT19937AR_D)/mt19937ar.h
 LOGIN_C = account_sql.c HPMlogin.c ipban_sql.c lclif.c login.c loginlog_sql.c
 LOGIN_OBJ = $(addprefix obj_sql/, $(patsubst %.c,%.o,$(LOGIN_C)))
 LOGIN_H = login.h account.h HPMlogin.h ipban.h lclif.h loginlog.h
-LOGIN_PH =
+LOGIN_PH = lclif.p.h
 
 HAVE_MYSQL=@HAVE_MYSQL@
 ifeq ($(HAVE_MYSQL),yes)
diff --git a/src/login/lclif.c b/src/login/lclif.c
index 203b0cbbc..9e672bab9 100644
--- a/src/login/lclif.c
+++ b/src/login/lclif.c
@@ -19,7 +19,7 @@
  */
 #define HERCULES_CORE
 
-#include "lclif.h"
+#include "lclif.p.h"
 
 #include "login/ipban.h"
 #include "login/login.h"
@@ -38,236 +38,9 @@
 #include "common/utils.h"
 
 struct lclif_interface lclif_s;
+struct lclif_interface_private lclif_p;
 struct lclif_interface *lclif;
 
-/* Definitions and macros */
-/// Maximum amount of packets processed at once from the same client
-#define MAX_PROCESSED_PACKETS (3)
-
-// Packet DB
-#define MIN_PACKET_DB 0x0064
-#define MAX_PACKET_DB 0x08ff
-
-/* Enums */
-
-/// Packet IDs
-enum login_packet_id {
-	// CA (Client to Login)
-	PACKET_ID_CA_LOGIN                = 0x0064,
-	PACKET_ID_CA_LOGIN2               = 0x01dd,
-	PACKET_ID_CA_LOGIN3               = 0x01fa,
-	PACKET_ID_CA_CONNECT_INFO_CHANGED = 0x0200,
-	PACKET_ID_CA_EXE_HASHCHECK        = 0x0204,
-	PACKET_ID_CA_LOGIN_PCBANG         = 0x0277,
-	PACKET_ID_CA_LOGIN4               = 0x027c,
-	PACKET_ID_CA_LOGIN_HAN            = 0x02b0,
-	PACKET_ID_CA_SSO_LOGIN_REQ        = 0x0825,
-	PACKET_ID_CA_REQ_HASH             = 0x01db,
-	PACKET_ID_CA_CHARSERVERCONNECT    = 0x2710, // Custom Hercules Packet
-	//PACKET_ID_CA_SSO_LOGIN_REQa       = 0x825a, /* unused */
-
-	// AC (Login to Client)
-	PACKET_ID_AC_ACCEPT_LOGIN         = 0x0069,
-	PACKET_ID_AC_REFUSE_LOGIN         = 0x006a,
-	PACKET_ID_SC_NOTIFY_BAN           = 0x0081,
-	PACKET_ID_AC_ACK_HASH             = 0x01dc,
-	PACKET_ID_AC_REFUSE_LOGIN_R2      = 0x083e,
-};
-
-/* Packets Structs */
-#if !defined(sun) && (!defined(__NETBSD__) || __NetBSD_Version__ >= 600000000) // NetBSD 5 and Solaris don't like pragma pack but accept the packed attribute
-#pragma pack(push, 1)
-#endif // not NetBSD < 6 / Solaris
-
-/**
- * Packet structure for CA_LOGIN.
- */
-struct packet_CA_LOGIN {
-	int16 packet_id;   ///< Packet ID (#PACKET_ID_CA_LOGIN)
-	uint32 version;    ///< Client Version
-	char id[24];       ///< Username
-	char password[24]; ///< Password
-	uint8 clienttype;  ///< Client Type
-} __attribute__((packed));
-
-/**
- * Packet structure for CA_LOGIN2.
- */
-struct packet_CA_LOGIN2 {
-	int16 packet_id;        ///< Packet ID (#PACKET_ID_CA_LOGIN2)
-	uint32 version;         ///< Client Version
-	char id[24];            ///< Username
-	uint8 password_md5[16]; ///< Password hash
-	uint8 clienttype;       ///< Client Type
-} __attribute__((packed));
-
-/**
- * Packet structure for CA_LOGIN3.
- */
-struct packet_CA_LOGIN3 {
-	int16 packet_id;        ///< Packet ID (#PACKET_ID_CA_LOGIN3)
-	uint32 version;         ///< Client Version
-	char id[24];            ///< Username
-	uint8 password_md5[16]; ///< Password hash
-	uint8 clienttype;       ///< Client Type
-	uint8 clientinfo;       ///< Index of the connection in the clientinfo file (+10 if the command-line contains "pc")
-} __attribute__((packed));
-
-/**
- * Packet structure for CA_LOGIN4.
- */
-struct packet_CA_LOGIN4 {
-	int16 packet_id;        ///< Packet ID (#PACKET_ID_CA_LOGIN4)
-	uint32 version;         ///< Client Version
-	char id[24];            ///< Username
-	uint8 password_md5[16]; ///< Password hash
-	uint8 clienttype;       ///< Client Type
-	char mac_address[13];   ///< MAC Address
-} __attribute__((packed));
-
-/**
- * Packet structure for CA_LOGIN_PCBANG.
- */
-struct packet_CA_LOGIN_PCBANG {
-	int16 packet_id;      ///< Packet ID (#PACKET_ID_CA_LOGIN_PCBANG)
-	uint32 version;	      ///< Client Version
-	char id[24];          ///< Username
-	char password[24];    ///< Password
-	uint8 clienttype;     ///< Client Type
-	char ip[16];          ///< IP Address
-	char mac_address[13]; ///< MAC Address
-} __attribute__((packed));
-
-/**
- * Packet structure for CA_LOGIN_HAN.
- */
-struct packet_CA_LOGIN_HAN {
-	int16 packet_id;        ///< Packet ID (#PACKET_ID_CA_LOGIN_HAN)
-	uint32 version;         ///< Client Version
-	char id[24];            ///< Username
-	char password[24];      ///< Password
-	uint8 clienttype;       ///< Client Type
-	char ip[16];            ///< IP Address
-	char mac_address[13];   ///< MAC Address
-	uint8 is_han_game_user; ///< 'isGravityID'
-} __attribute__((packed));
-
-/**
- * Packet structure for CA_SSO_LOGIN_REQ.
- *
- * Variable-length packet.
- */
-struct packet_CA_SSO_LOGIN_REQ {
-	int16 packet_id;      ///< Packet ID (#PACKET_ID_CA_SSO_LOGIN_REQ)
-	int16 packet_len;     ///< Length (variable length)
-	uint32 version;       ///< Client Version
-	uint8 clienttype;     ///< Client Type
-	char id[24];          ///< Username
-	char password[27];    ///< Password
-	int8 mac_address[17]; ///< MAC Address
-	char ip[15];          ///< IP Address
-	char t1[];            ///< SSO Login Token (variable length)
-} __attribute__((packed));
-
-#if 0 // Unused
-struct packet_CA_SSO_LOGIN_REQa {
-	int16 packet_id;
-	int16 packet_len;
-	uint32 version;
-	uint8 clienttype;
-	char id[24];
-	int8 mac_address[17];
-	char ip[15];
-	char t1[];
-} __attribute__((packed));
-#endif // unused
-
-/**
- * Packet structure for CA_CONNECT_INFO_CHANGED.
- *
- * New alive packet. Used to verify if client is always alive.
- */
-struct packet_CA_CONNECT_INFO_CHANGED {
-	int16 packet_id; ///< Packet ID (#PACKET_ID_CA_CONNECT_INFO_CHANGED)
-	char id[24];    ///< account.userid
-} __attribute__((packed));
-
-/**
- * Packet structure for CA_EXE_HASHCHECK.
- *
- * (kRO 2004-05-31aSakexe langtype 0 and 6)
- */
-struct packet_CA_EXE_HASHCHECK {
-	int16 packet_id;      ///< Packet ID (#PACKET_ID_CA_EXE_HASHCHECK)
-	uint8 hash_value[16]; ///< Client MD5 hash
-} __attribute__((packed));
-
-/**
- * Packet structure for CA_REQ_HASH.
- */
-struct packet_CA_REQ_HASH {
-	int16 packet_id; ///< Packet ID (#PACKET_ID_CA_REQ_HASH)
-} __attribute__((packed));
-
-struct packet_CA_CHARSERVERCONNECT {
-	int16 packet_id;
-	char userid[24];
-	char password[24];
-	int32 unknown;
-	int32 ip;
-	int16 port;
-	char name[20];
-	int16 unknown2;
-	int16 type;
-	int16 new;
-} __attribute__((packed));
-
-struct packet_SC_NOTIFY_BAN {
-	int16 packet_id;
-	uint8 error_code;
-} __attribute__((packed));
-
-struct packet_AC_REFUSE_LOGIN {
-	int16 packet_id;
-	uint8 error_code;
-	char block_date[20];
-} __attribute__((packed));
-
-struct packet_AC_REFUSE_LOGIN_R2 {
-	int16 packet_id;
-	uint32 error_code;
-	char block_date[20];
-} __attribute__((packed));
-
-struct packet_AC_ACCEPT_LOGIN {
-	int16 packet_id;
-	int16 packet_len;
-	int32 auth_code;
-	uint32 aid;
-	uint32 user_level;
-	uint32 last_login_ip;
-	char last_login_time[26];
-	uint8 sex;
-	struct {
-		uint32 ip;
-		int16 port;
-		char name[20];
-		uint16 usercount;
-		uint16 state;
-		uint16 property;
-	} server_list[];
-} __attribute__((packed));
-
-struct packet_AC_ACK_HASH {
-	int16 packet_id;
-	int16 packet_len;
-	uint8 secret[];
-} __attribute__((packed));
-
-#if !defined(sun) && (!defined(__NETBSD__) || __NetBSD_Version__ >= 600000000) // NetBSD 5 and Solaris don't like pragma pack but accept the packed attribute
-#pragma pack(pop)
-#endif // not NetBSD < 6 / Solaris
-
 struct login_packet_db packet_db[MAX_PACKET_DB + 1];
 
 void lclif_connection_error(int fd, uint8 error)
@@ -589,7 +362,7 @@ int lclif_parse(int fd)
 		if (packet_len < 2)
 			return 0;
 
-		result = lclif->parse_sub(fd, sd);
+		result = lclif->p->parse_sub(fd, sd);
 
 		switch (result) {
 		case PACKET_SKIP:
@@ -723,7 +496,7 @@ void packetdb_loaddb(void)
 
 void lclif_init(void)
 {
-	packetdb_loaddb();
+	lclif->p->packetdb_loaddb();
 }
 
 void lclif_final(void)
@@ -733,6 +506,7 @@ void lclif_final(void)
 void lclif_defaults(void)
 {
 	lclif = &lclif_s;
+	lclif->p = &lclif_p;
 
 	lclif->init = lclif_init;
 	lclif->final = lclif_final;
@@ -746,5 +520,7 @@ void lclif_defaults(void)
 	lclif->packet = lclif_packet;
 	lclif->parse_packet = lclif_parse_packet;
 	lclif->parse = lclif_parse;
-	lclif->parse_sub = lclif_parse_sub;
+
+	lclif->p->packetdb_loaddb = packetdb_loaddb;
+	lclif->p->parse_sub = lclif_parse_sub;
 }
diff --git a/src/login/lclif.h b/src/login/lclif.h
index b6dac5d35..cf6314fc8 100644
--- a/src/login/lclif.h
+++ b/src/login/lclif.h
@@ -24,6 +24,7 @@
 
 /* Forward Declarations */
 struct login_session_data;
+struct lclif_interface_private;
 
 /* Enums */
 /// Parse function return code
@@ -47,6 +48,8 @@ struct login_packet_db {
 };
 
 struct lclif_interface {
+	struct lclif_interface_private *p; ///< Private interface
+
 	void (*init)(void);
 	void (*final)(void);
 
@@ -58,7 +61,6 @@ struct lclif_interface {
 	const struct login_packet_db *(*packet)(int16 packet_id);
 	enum parsefunc_rcode (*parse_packet)(const struct login_packet_db *lpd, int fd, struct login_session_data *sd);
 	int (*parse)(int fd);
-	enum parsefunc_rcode (*parse_sub)(int fd, struct login_session_data *sd);
 };
 
 #ifdef HERCULES_CORE
diff --git a/src/login/lclif.p.h b/src/login/lclif.p.h
new file mode 100644
index 000000000..ad9a08e4d
--- /dev/null
+++ b/src/login/lclif.p.h
@@ -0,0 +1,264 @@
+/**
+ * This file is part of Hercules.
+ * http://herc.ws - http://github.com/HerculesWS/Hercules
+ *
+ * Copyright (C) 2016  Hercules Dev Team
+ *
+ * Hercules is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#ifndef LOGIN_LCLIF_P_H
+#define LOGIN_LCLIF_P_H
+
+#include "login/lclif.h"
+
+#include "common/hercules.h"
+#include "common/mmo.h"
+
+/* Definitions and macros */
+/// Maximum amount of packets processed at once from the same client
+#define MAX_PROCESSED_PACKETS (3)
+
+// Packet DB
+#define MIN_PACKET_DB 0x0064
+#define MAX_PACKET_DB 0x08ff
+
+/* Enums */
+
+/// Packet IDs
+enum login_packet_id {
+	// CA (Client to Login)
+	PACKET_ID_CA_LOGIN                = 0x0064,
+	PACKET_ID_CA_LOGIN2               = 0x01dd,
+	PACKET_ID_CA_LOGIN3               = 0x01fa,
+	PACKET_ID_CA_CONNECT_INFO_CHANGED = 0x0200,
+	PACKET_ID_CA_EXE_HASHCHECK        = 0x0204,
+	PACKET_ID_CA_LOGIN_PCBANG         = 0x0277,
+	PACKET_ID_CA_LOGIN4               = 0x027c,
+	PACKET_ID_CA_LOGIN_HAN            = 0x02b0,
+	PACKET_ID_CA_SSO_LOGIN_REQ        = 0x0825,
+	PACKET_ID_CA_REQ_HASH             = 0x01db,
+	PACKET_ID_CA_CHARSERVERCONNECT    = 0x2710, // Custom Hercules Packet
+	//PACKET_ID_CA_SSO_LOGIN_REQa       = 0x825a, /* unused */
+
+	// AC (Login to Client)
+	PACKET_ID_AC_ACCEPT_LOGIN         = 0x0069,
+	PACKET_ID_AC_REFUSE_LOGIN         = 0x006a,
+	PACKET_ID_SC_NOTIFY_BAN           = 0x0081,
+	PACKET_ID_AC_ACK_HASH             = 0x01dc,
+	PACKET_ID_AC_REFUSE_LOGIN_R2      = 0x083e,
+};
+
+/* Packets Structs */
+#if !defined(sun) && (!defined(__NETBSD__) || __NetBSD_Version__ >= 600000000) // NetBSD 5 and Solaris don't like pragma pack but accept the packed attribute
+#pragma pack(push, 1)
+#endif // not NetBSD < 6 / Solaris
+
+/**
+ * Packet structure for CA_LOGIN.
+ */
+struct packet_CA_LOGIN {
+	int16 packet_id;   ///< Packet ID (#PACKET_ID_CA_LOGIN)
+	uint32 version;    ///< Client Version
+	char id[24];       ///< Username
+	char password[24]; ///< Password
+	uint8 clienttype;  ///< Client Type
+} __attribute__((packed));
+
+/**
+ * Packet structure for CA_LOGIN2.
+ */
+struct packet_CA_LOGIN2 {
+	int16 packet_id;        ///< Packet ID (#PACKET_ID_CA_LOGIN2)
+	uint32 version;         ///< Client Version
+	char id[24];            ///< Username
+	uint8 password_md5[16]; ///< Password hash
+	uint8 clienttype;       ///< Client Type
+} __attribute__((packed));
+
+/**
+ * Packet structure for CA_LOGIN3.
+ */
+struct packet_CA_LOGIN3 {
+	int16 packet_id;        ///< Packet ID (#PACKET_ID_CA_LOGIN3)
+	uint32 version;         ///< Client Version
+	char id[24];            ///< Username
+	uint8 password_md5[16]; ///< Password hash
+	uint8 clienttype;       ///< Client Type
+	uint8 clientinfo;       ///< Index of the connection in the clientinfo file (+10 if the command-line contains "pc")
+} __attribute__((packed));
+
+/**
+ * Packet structure for CA_LOGIN4.
+ */
+struct packet_CA_LOGIN4 {
+	int16 packet_id;        ///< Packet ID (#PACKET_ID_CA_LOGIN4)
+	uint32 version;         ///< Client Version
+	char id[24];            ///< Username
+	uint8 password_md5[16]; ///< Password hash
+	uint8 clienttype;       ///< Client Type
+	char mac_address[13];   ///< MAC Address
+} __attribute__((packed));
+
+/**
+ * Packet structure for CA_LOGIN_PCBANG.
+ */
+struct packet_CA_LOGIN_PCBANG {
+	int16 packet_id;      ///< Packet ID (#PACKET_ID_CA_LOGIN_PCBANG)
+	uint32 version;	      ///< Client Version
+	char id[24];          ///< Username
+	char password[24];    ///< Password
+	uint8 clienttype;     ///< Client Type
+	char ip[16];          ///< IP Address
+	char mac_address[13]; ///< MAC Address
+} __attribute__((packed));
+
+/**
+ * Packet structure for CA_LOGIN_HAN.
+ */
+struct packet_CA_LOGIN_HAN {
+	int16 packet_id;        ///< Packet ID (#PACKET_ID_CA_LOGIN_HAN)
+	uint32 version;         ///< Client Version
+	char id[24];            ///< Username
+	char password[24];      ///< Password
+	uint8 clienttype;       ///< Client Type
+	char ip[16];            ///< IP Address
+	char mac_address[13];   ///< MAC Address
+	uint8 is_han_game_user; ///< 'isGravityID'
+} __attribute__((packed));
+
+/**
+ * Packet structure for CA_SSO_LOGIN_REQ.
+ *
+ * Variable-length packet.
+ */
+struct packet_CA_SSO_LOGIN_REQ {
+	int16 packet_id;      ///< Packet ID (#PACKET_ID_CA_SSO_LOGIN_REQ)
+	int16 packet_len;     ///< Length (variable length)
+	uint32 version;       ///< Clientver
+	uint8 clienttype;     ///< Clienttype
+	char id[24];          ///< Username
+	char password[27];    ///< Password
+	int8 mac_address[17]; ///< MAC Address
+	char ip[15];          ///< IP Address
+	char t1[];            ///< SSO Login Token (variable length)
+} __attribute__((packed));
+
+#if 0 // Unused
+struct packet_CA_SSO_LOGIN_REQa {
+	int16 packet_id;
+	int16 packet_len;
+	uint32 version;
+	uint8 clienttype;
+	char id[24];
+	int8 mac_address[17];
+	char ip[15];
+	char t1[];
+} __attribute__((packed));
+#endif // unused
+
+/**
+ * Packet structure for CA_CONNECT_INFO_CHANGED.
+ *
+ * New alive packet. Used to verify if client is always alive.
+ */
+struct packet_CA_CONNECT_INFO_CHANGED {
+	int16 packet_id; ///< Packet ID (#PACKET_ID_CA_CONNECT_INFO_CHANGED)
+	char id[24];    ///< account.userid
+} __attribute__((packed));
+
+/**
+ * Packet structure for CA_EXE_HASHCHECK.
+ *
+ * (kRO 2004-05-31aSakexe langtype 0 and 6)
+ */
+struct packet_CA_EXE_HASHCHECK {
+	int16 packet_id;      ///< Packet ID (#PACKET_ID_CA_EXE_HASHCHECK)
+	uint8 hash_value[16]; ///< Client MD5 hash
+} __attribute__((packed));
+
+/**
+ * Packet structure for CA_REQ_HASH.
+ */
+struct packet_CA_REQ_HASH {
+	int16 packet_id; ///< Packet ID (#PACKET_ID_CA_REQ_HASH)
+} __attribute__((packed));
+
+struct packet_CA_CHARSERVERCONNECT {
+	int16 packet_id;
+	char userid[24];
+	char password[24];
+	int32 unknown;
+	int32 ip;
+	int16 port;
+	char name[20];
+	int16 unknown2;
+	int16 type;
+	int16 new;
+} __attribute__((packed));
+
+struct packet_SC_NOTIFY_BAN {
+	int16 packet_id;
+	uint8 error_code;
+} __attribute__((packed));
+
+struct packet_AC_REFUSE_LOGIN {
+	int16 packet_id;
+	uint8 error_code;
+	char block_date[20];
+} __attribute__((packed));
+
+struct packet_AC_REFUSE_LOGIN_R2 {
+	int16 packet_id;
+	uint32 error_code;
+	char block_date[20];
+} __attribute__((packed));
+
+struct packet_AC_ACCEPT_LOGIN {
+	int16 packet_id;
+	int16 packet_len;
+	int32 auth_code;
+	uint32 aid;
+	uint32 user_level;
+	uint32 last_login_ip;
+	char last_login_time[26];
+	uint8 sex;
+	struct {
+		uint32 ip;
+		int16 port;
+		char name[20];
+		uint16 usercount;
+		uint16 state;
+		uint16 property;
+	} server_list[];
+} __attribute__((packed));
+
+struct packet_AC_ACK_HASH {
+	int16 packet_id;
+	int16 packet_len;
+	uint8 secret[];
+} __attribute__((packed));
+
+#if !defined(sun) && (!defined(__NETBSD__) || __NetBSD_Version__ >= 600000000) // NetBSD 5 and Solaris don't like pragma pack but accept the packed attribute
+#pragma pack(pop)
+#endif // not NetBSD < 6 / Solaris
+
+/**
+ * Login Client Interface Private Interface
+ */
+struct lclif_interface_private {
+	void (*packetdb_loaddb)(void);
+	enum parsefunc_rcode (*parse_sub)(int fd, struct login_session_data *sd);
+};
+
+#endif // LOGIN_LCLIF_P_H
diff --git a/src/plugins/HPMHooking.c b/src/plugins/HPMHooking.c
index f809ff4ab..6530035b9 100644
--- a/src/plugins/HPMHooking.c
+++ b/src/plugins/HPMHooking.c
@@ -30,6 +30,7 @@
 #define HPM_POINTS_INCLUDE "HPMHooking/HPMHooking_login.HookingPoints.inc"
 #define HPM_SOURCES_INCLUDE "HPMHooking/HPMHooking_login.sources.inc"
 #include "login/lclif.h"
+#include "login/lclif.p.h"
 #include "login/login.h"
 #elif defined (HPMHOOKING_CHAR)
 #define HPM_SERVER_TYPE SERVER_TYPE_CHAR