From c4edeafd504a560fde78dc0c5f9280c3e012612a Mon Sep 17 00:00:00 2001
From: Paul Broadhead <pjbroad@twinmoons.org.uk>
Date: Sat, 31 May 2014 22:05:55 +0100
Subject: [PATCH] Added support for server specified spell/buff durations.

---
 client_serv.h     |   5 ++
 draw_scene.c      |   3 +
 multiplayer.c     |  29 +++++++
 multiplayer.h     |  28 +++++++
 named_colours.cpp |   1 +
 named_colours.xml |   1 +
 spells.c          | 207 +++++++++++++++++++++++++++++++++++-----------
 spells.h          |   2 +
 spells.xml        |   8 --
 text.c            |   1 +
 10 files changed, 231 insertions(+), 54 deletions(-)

diff --git a/client_serv.h b/client_serv.h
index 480fac8cf..0b5cc6f67 100644
--- a/client_serv.h
+++ b/client_serv.h
@@ -699,6 +699,9 @@ typedef enum
 
 #define DO_EMOTE 70
 
+/* send: 16 bit buff bit-mask (only one set bit), server responds with SEND_BUFF_DURATION */
+#define GET_BUFF_DURATION 71
+
 #define LOG_IN 140
 #define CREATE_CHAR 141
 
@@ -810,6 +813,8 @@ typedef enum
 #define QUEST_FINISHED 94
 /* sent: 5 x 32 bit integers, each active bit is an achievement the last "You see: name" player has */
 #define SEND_ACHIEVEMENTS 95
+/* sent: 1 single byte duration, to get the time remaining multiply the by 10, the result is seconds */
+#define SEND_BUFF_DURATION 96
 
 #define SEND_WEATHER 100
 
diff --git a/draw_scene.c b/draw_scene.c
index b1ff53be2..4a4addce8 100644
--- a/draw_scene.c
+++ b/draw_scene.c
@@ -22,6 +22,7 @@
 #include "shadows.h"
 #include "skeletons.h"
 #include "sky.h"
+#include "spells.h"
 #include "sound.h"
 #include "storage.h"
 #include "text.h"
@@ -174,6 +175,8 @@ void draw_scene()
 			check_afk_state();
 			/* the timer in the hud */
 			update_hud_timer();
+			/* check if we need to do buff duration requests */
+			check_then_do_buff_duration_request();
 			/* until next time */
 			last_half_second_timer = current_time;
 		}
diff --git a/multiplayer.c b/multiplayer.c
index 9e3077001..3868de198 100644
--- a/multiplayer.c
+++ b/multiplayer.c
@@ -104,6 +104,26 @@ Uint32 next_second_time = 0;
 short real_game_minute = 0;
 short real_game_second = 0;
 
+/* real_game_second_valid set when we know the server seconds */
+static short real_game_second_valid = 0;
+int is_real_game_second_valid(void) { return real_game_second_valid; }
+void set_real_game_second_valid(void) { real_game_second_valid = 1; }
+
+/* get the current game time in seconds */
+Uint32 get_game_time_sec(void)
+{
+	return real_game_minute * 60 + real_game_second;
+}
+
+/* get the difference between the supplied time and current game time, allowing for wrap round */
+Uint32 diff_game_time_sec(Uint32 ref_time)
+{
+	Uint32 curr_game_time = get_game_time_sec();
+	if (ref_time > curr_game_time)
+		curr_game_time += 6 * 60 * 60;
+	return curr_game_time - ref_time;
+}
+
 
 /*
  *	Date handling code:
@@ -758,6 +778,7 @@ void process_message_from_server (const Uint8 *in_data, int data_length)
 				real_game_minute= SDL_SwapLE16(*((short *)(in_data+3)));
 				real_game_minute %= 360;
 				real_game_second = 0;
+				set_real_game_second_valid();
 				next_second_time = cur_time+1000;
 				if (real_game_minute < last_real_game_minute)
 					invalidate_date();
@@ -2185,6 +2206,14 @@ void process_message_from_server (const Uint8 *in_data, int data_length)
 				free(achievement_data);
 			}
 			break;
+		case SEND_BUFF_DURATION:
+			{
+				if (data_length <= 3)
+					LOG_WARNING("CAUTION: Possibly forged/invalid SEND_BUFF_DURATION packet received.\n");
+				else
+					here_is_a_buff_duration((Uint8)in_data[3]);
+				break;
+			}
 		default:
 			{
 				// Unknown packet type??
diff --git a/multiplayer.h b/multiplayer.h
index 03ad0bce8..e5e23b7bf 100644
--- a/multiplayer.h
+++ b/multiplayer.h
@@ -36,6 +36,34 @@ extern Uint32 next_second_time; /*!< the time of the next second */
 extern short real_game_minute; /*!< the real game minute */
 extern short real_game_second; /*!< the real game second */
 
+/*!
+ * \brief	check validity of game seconds
+ *
+ * \retval	true if we have set seconds.
+*/
+int is_real_game_second_valid(void);
+
+/*!
+ * \brief	Set game seconds as valid.
+ * 
+*/
+void set_real_game_second_valid(void);
+
+/*!
+ * \brief	Get the current game time.
+ * 
+ * \retval	game time in seconds.
+*/
+Uint32 get_game_time_sec(void);
+
+/*!
+ * \brief	Get the time difference from current game time.
+ *
+ * \param	the relative time to compare
+ * 
+ * \retval	the time difference in seconds, wrapped appropriately
+*/
+Uint32 diff_game_time_sec(Uint32 ref_time);
 
 extern time_t last_heart_beat; /*!< a timestamp that inidicates when the last message was sent to the server */
 
diff --git a/named_colours.cpp b/named_colours.cpp
index 08dc62e46..b48607389 100644
--- a/named_colours.cpp
+++ b/named_colours.cpp
@@ -182,6 +182,7 @@ namespace ELGL_Colour
 		add("minimap.otherplayer", Colour_Tuple(1.0f, 1.0f, 1.0f));
 		add("global.mousehighlight", Colour_Tuple(0.5f, 0.5f, 1.0f));
 		add("global.mouseselected", Colour_Tuple(0.4f, 0.8f, 1.0f));
+		add("buff.duration.background", Colour_Tuple(0.1f, 0.3f, 1.0f, 0.7f));
 	}
 
 } // end namespace
diff --git a/named_colours.xml b/named_colours.xml
index 55d4a4041..f6c25efd2 100644
--- a/named_colours.xml
+++ b/named_colours.xml
@@ -14,6 +14,7 @@
 <colour name="minimap.otherplayer" r="1.0" g="1.0" b="1.0"/>
 <colour name="global.mousehighlight" r="0.5" g="0.5" b="1.0"/>
 <colour name="global.mouseselected" r="0.4" g="0.8" b="1.0"/>
+<colour name="buff.duration.background" r="0.1" g="0.3" b="1.0" a="0.7"/>
 
 <!-- Alpha can be specified too
 <colour name="test" r="1.0" g="1.0" b="1.0" a="1.0"/>
diff --git a/spells.c b/spells.c
index 5e9271e7c..f94ec19e7 100644
--- a/spells.c
+++ b/spells.c
@@ -16,6 +16,7 @@
 #include "stats.h"
 #include "colors.h"
 #include "multiplayer.h"
+#include "named_colours.h"
 #include "pathfinder.h"
 #include "textures.h"
 #include "translate.h"
@@ -72,7 +73,6 @@ typedef struct {
 	int reagents_id[4]; //reagents needed image id
 	Uint16 reagents_uid[4]; //reagents needed, unique item id
 	int reagents_qt[4]; //their quantities
-	Uint32 duration;
 	Uint32 buff;
 	int uncastable; //0 if castable, otherwise if something missing
 } spell_info;
@@ -133,6 +133,149 @@ int spell_mini_x_len=0;
 int spell_mini_y_len=0;
 int spell_mini_rows=0;
 
+
+/* spell duration state */
+#undef BUFF_DURATION_DEBUG
+static Uint16 requested_durations = 0;
+static Uint16 last_requested_duration = 0;
+static size_t buff_duration_colour_id = 0;
+
+/* mapping of spell buff value from spells.xml to buff bit-masks */
+typedef struct buff_buffmask {
+	Uint32 buff;
+	Uint16 buffmask;
+} buff_buffmask;
+static buff_buffmask buff_to_buffmask[NUM_BUFFS] = {
+		{11, BUFF_INVISIBILITY},
+		{3, BUFF_MAGIC_IMMUNITY},
+		{1, BUFF_MAGIC_PROTECTION},
+		{23, BUFF_COLD_SHIELD},
+		{24, BUFF_HEAT_SHIELD},
+		{25, BUFF_RADIATION_SHIELD},
+		{0, BUFF_SHIELD},
+		{7, BUFF_TRUE_SIGHT},
+		{5, BUFF_ACCURACY},
+		{6, BUFF_EVASION},
+		{0xFFFFFFFF, BUFF_DOUBLE_SPEED}
+	};
+
+/* display debug information about buff durations */
+#if defined(BUFF_DURATION_DEBUG)
+static void duration_debug(int buff, int duration, const char*message)
+{
+	size_t i;
+	char buf[128];
+	const char *buff_name = "Unknown";
+	if (buff == 5)
+		buff_name = "Accuracy";
+	else if (buff == 6)
+		buff_name = "Evasion";
+	else
+		for (i=0; i<SPELLS_NO; i++)
+			if (spells_list[i].buff == buff)
+			{
+				buff_name = spells_list[i].name;
+				break;
+			}
+	safe_snprintf(buf, sizeof(buf), "Debug: Buff [%s] %s: %d seconds", buff_name, message, duration, message);
+	LOG_TO_CONSOLE (c_red1, buf);
+}
+#endif
+
+/* Called when the client receives SEND_BUFF_DURATION from server.
+ * Set the duration and start the time out for the buff duration.
+*/
+void here_is_a_buff_duration(Uint8 duration)
+{
+	/* check the request is on the queue */
+	if (requested_durations & last_requested_duration)
+	{
+		size_t i;
+		Uint32 buff = 0xFFFFFFFF;
+
+		/* get the spell / buff value from the bit-mask we used */
+		for (i=0; i<NUM_BUFFS; i++)
+			if (last_requested_duration == buff_to_buffmask[i].buffmask)
+			{
+				buff = buff_to_buffmask[i].buff;
+				break;
+			}
+
+		/* if we have a matching spell, set the duration information */
+		for (i = 0; i < NUM_ACTIVE_SPELLS; i++)
+		{
+			if ((active_spells[i].spell != -1) && (buff == active_spells[i].spell))
+			{
+				active_spells[i].cast_time = get_game_time_sec();
+				active_spells[i].duration = (Uint32)duration;
+#if defined(BUFF_DURATION_DEBUG)
+				duration_debug(buff, active_spells[i].duration, "duration from server");
+#endif
+				break;
+			}
+		}
+
+		/* clear request */
+		requested_durations &= ~last_requested_duration;
+		last_requested_duration = 0;
+	}
+
+	/* to save waiting, process others in the queue now */
+	check_then_do_buff_duration_request();
+}
+
+
+/* Called periodically from the main loop
+ * Time out any old requests.
+ * If no request is pending but we have one in the queue, ask the server for the duration.
+*/
+void check_then_do_buff_duration_request(void)
+{
+	static Uint32 last_request_time = 0;
+
+	/* wait until the client knows the game time fully */
+	if (!is_real_game_second_valid())
+		return;
+
+	/* stop waiting for server response after 10 seconds, clear all other requests */
+	if (last_requested_duration && abs(SDL_GetTicks() - last_request_time) > 10000)
+	{
+		last_requested_duration = 0;
+		requested_durations = 0;
+	}
+
+	/* else if there is no active request but we have one queued, make the server request */
+	else if (!last_requested_duration && requested_durations)
+	{
+		Uint8 str[4];
+
+		last_requested_duration = 1;
+		while (!(requested_durations & last_requested_duration))
+			last_requested_duration <<= 1;
+		last_request_time = SDL_GetTicks();
+
+		str[0] = GET_BUFF_DURATION;
+		*((Uint16 *)(str+1)) = SDL_SwapLE16(requested_durations);
+		my_tcp_send (my_socket, str, 3);
+	}
+}
+
+/*	Called when we receive notification that a spell is active.
+ * 	If the spell is in the buff bit-mask array, queue the duration request.
+*/
+static void request_buff_duration(Uint32 buff)
+{
+	size_t i;
+	for (i=0; i<NUM_BUFFS; i++)
+		if (buff == buff_to_buffmask[i].buff)
+		{
+			requested_durations |= buff_to_buffmask[i].buffmask;
+			check_then_do_buff_duration_request();
+			return;
+		}
+}
+
+
 typedef struct {
 	char spell_name[60];//The spell_name
 	Sint8 spell_image;//image_id
@@ -223,6 +366,8 @@ int init_spells ()
 	int ok = 1;
 	char *fname="./spells.xml";
 
+	buff_duration_colour_id = elglGetColourId("buff.duration.background");
+
 	//init textures and structs
 #ifdef	NEW_TEXTURES
 	sigils_text = load_texture_cached("textures/sigils.dds", tt_gui);
@@ -413,17 +558,6 @@ int init_spells ()
 				data = get_XML_node(data->next, "reagent");				
 			}
 
-			data = get_XML_node(node->children, "duration");
-
-			if (data != 0)
-			{
-				spells_list[i].duration = get_int_value(data);
-			}
-			else
-			{
-				spells_list[i].duration = 0;
-			}
-
 			data = get_XML_node(node->children, "buff");
 
 			if (data != 0)
@@ -578,26 +712,20 @@ void draw_spell_icon_strings(void)
 //ACTIVE SPELLS
 void get_active_spell(int pos, int spell)
 {
-	Uint32 i;
-
 	active_spells[pos].spell = spell;
-	active_spells[pos].cast_time = SDL_GetTicks();
+	active_spells[pos].cast_time = 0;
+	request_buff_duration(spell);
 #ifdef NEW_SOUND
 	active_spells[pos].sound = add_spell_sound(spell);
 #endif // NEW_SOUND
-
-	for (i = 0; i < SPELLS_NO; i++)
-	{
-		if (spell == spells_list[i].buff)
-		{
-			active_spells[pos].duration = spells_list[i].duration;
-			return;
-		}
-	}
 }
 
 void remove_active_spell(int pos)
 {
+#if defined(BUFF_DURATION_DEBUG)
+	if (active_spells[pos].duration > 0)
+		duration_debug(active_spells[pos].spell, diff_game_time_sec(active_spells[pos].cast_time), "actual duration");
+#endif
 	if (active_spells[pos].spell == 2)
 		poison_drop_counter = 0;
 	active_spells[pos].spell = -1;
@@ -611,25 +739,13 @@ void remove_active_spell(int pos)
 
 void get_active_spell_list(const Uint8 *my_spell_list)
 {
-	Uint32 i, j;
-	int cur_spell;
+	size_t i;
 
 	for (i = 0; i < NUM_ACTIVE_SPELLS; i++)
 	{
 		active_spells[i].spell = my_spell_list[i];
-		active_spells[i].cast_time = 0xFFFFFFFF;
-
-		cur_spell = my_spell_list[i];
-
-		for (j = 0; j < SPELLS_NO; j++)
-		{
-			if (cur_spell == spells_list[j].buff)
-			{
-				active_spells[i].duration =
-					spells_list[j].duration;
-				break;
-			}
-		}
+		active_spells[i].cast_time = 0;
+		request_buff_duration(my_spell_list[i]);
 #ifdef NEW_SOUND
 		active_spells[i].sound = add_spell_sound(active_spells[i].spell);
 #endif // NEW_SOUND
@@ -675,8 +791,9 @@ void time_out(const float x_start, const float y_start, const float gridsize,
 	const float progress)
 {
 	glDisable(GL_TEXTURE_2D);
+	glEnable(GL_BLEND);
 
-	glColor3f(0.0f, 0.7f, 0.0f);
+	elglColourI(buff_duration_colour_id);
 
 	glBegin(GL_QUADS);
 		glVertex2f(x_start, y_start + gridsize * progress);
@@ -684,6 +801,7 @@ void time_out(const float x_start, const float y_start, const float gridsize,
 		glVertex2f(x_start + gridsize, y_start + gridsize);
 		glVertex2f(x_start, y_start + gridsize);
 	glEnd();
+	glDisable(GL_BLEND);
 	glEnable(GL_TEXTURE_2D);
 	glColor3f(1.0f, 1.0f, 1.0f);
 }
@@ -691,15 +809,13 @@ void time_out(const float x_start, const float y_start, const float gridsize,
 void display_spells_we_have()
 {
 	Uint32 i;
-	float scale, duration, cur_time;
+	float scale, duration;
 
 #ifdef OPENGL_TRACE
 	CHECK_GL_ERRORS();
 #endif //OPENGL_TRACE
 	glBlendFunc(GL_SRC_ALPHA,GL_ONE_MINUS_SRC_ALPHA);
 
-	cur_time = SDL_GetTicks();
-
 	//ok, now let's draw the objects...
 	for (i = 0; i < NUM_ACTIVE_SPELLS; i++)
 	{
@@ -721,8 +837,7 @@ void display_spells_we_have()
 
 			if (duration > 0.0)
 			{
-				scale = (cur_time - active_spells[i].cast_time)
-					/ duration;
+				scale = diff_game_time_sec(active_spells[i].cast_time) / duration;
 
 				if ((scale >= 0.0) && (scale <= 1.0))
 				{
@@ -1435,7 +1550,7 @@ static void spell_cast(const Uint8 id)
 	{
 		if (active_spells[i].spell == spell)
 		{
-			active_spells[i].cast_time = SDL_GetTicks();
+			request_buff_duration(spell);
 			return;
 		}
 	}
diff --git a/spells.h b/spells.h
index 4615bc025..66f904532 100644
--- a/spells.h
+++ b/spells.h
@@ -188,6 +188,8 @@ void restart_active_spell_sounds(void);
 void increment_poison_incidence(void);
 void draw_spell_icon_strings(void);
 extern int show_poison_count;
+void here_is_a_buff_duration(Uint8 duration);
+void check_then_do_buff_duration_request(void);
 
 #ifdef __cplusplus
 } // extern "C"
diff --git a/spells.xml b/spells.xml
index ba298506f..0aaf11470 100644
--- a/spells.xml
+++ b/spells.xml
@@ -132,7 +132,6 @@
 		<reagent id="56" uid="37">4</reagent>
 		<reagent id="60" uid="41">4</reagent>
 		<reagent id="54" uid="35">4</reagent>
-		<duration>60000</duration>
 		<buff>7</buff>
 	</spell>
 	<spell>
@@ -164,7 +163,6 @@
 		<reagent id="53" uid="34">10</reagent>
 		<reagent id="56" uid="37">10</reagent>
 		<reagent id="55" uid="36">10</reagent>
-		<duration>30000</duration>
 		<buff>11</buff>
 	</spell>
 <!-- attack group -->
@@ -250,7 +248,6 @@
 		<sigil>21</sigil>	
 		<reagent id="60" uid="41">1</reagent>
 		<reagent id="56" uid="37">1</reagent>
-		<duration>190000</duration>
 		<buff>1</buff>
 	</spell>
 	<spell>
@@ -265,7 +262,6 @@
 		<sigil>15</sigil>	
 		<sigil>21</sigil>	
 		<reagent id="55" uid="36">1</reagent>
-		<duration>130000</duration>
 		<buff>0</buff>
 	</spell>
 	<spell>
@@ -282,7 +278,6 @@
 		<sigil>21</sigil>	
 		<reagent id="60" uid="41">2</reagent>
 		<reagent id="56" uid="37">1</reagent>
-		<duration>100000</duration>
 		<buff>3</buff>
 	</spell>
 	<spell>
@@ -299,7 +294,6 @@
 		<reagent id="56" uid="37">3</reagent>
 		<reagent id="55" uid="36">3</reagent>
 		<reagent id="51" uid="32">4</reagent>
-		<duration>120000</duration>
 		<buff>24</buff>
 	</spell>
 	<spell>
@@ -316,7 +310,6 @@
 		<reagent id="56" uid="37">3</reagent>
 		<reagent id="55" uid="36">3</reagent>
 		<reagent id="50" uid="31">4</reagent>
-		<duration>120000</duration>
 		<buff>23</buff>
 	</spell>
 	<spell>
@@ -334,7 +327,6 @@
 		<reagent id="56" uid="37">3</reagent>
 		<reagent id="55" uid="36">3</reagent>
 		<reagent id="60" uid="41">4</reagent>
-		<duration>160000</duration>
 		<buff>25</buff>
 	</spell>
 </Spell_list>
diff --git a/text.c b/text.c
index ccdb3ca80..ef35bb9aa 100644
--- a/text.c
+++ b/text.c
@@ -530,6 +530,7 @@ int filter_or_ignore_text (char *text_to_add, int len, int size, Uint8 channel)
 	if (from_color_char (text_to_add[0]) == c_green1 && my_strncompare(text_to_add+1,"Game Time", 9))
 	{
 		real_game_second = atoi(&text_to_add[18]);
+		set_real_game_second_valid();
 		next_second_time = cur_time + 1000;
         new_second();
 	}