v1.01 - Keep track of quest completion times

Now register the time a player takes to complete a quest. If the player beats his/her PB, it's also updated.
You may need to do a small SQL migration, see migration file in _private

Author: Harest

GetBoard.php

@@ -39,12 +39,27 @@
 			require(__DIR__."/includes/dbConfig.php");
 			$dbh = databaseConnect($dbHost, $dbUser, $dbPwd, $dbName); // Database Handler
 		}
-		$sql = "SELECT login, nickname FROM players WHERE quest_id = :questid AND status = 1 ORDER BY completion_date ASC";
+		$sql = "SELECT login, nickname, completion_time_best as bestTime, completion_time_first as firstTime FROM players WHERE quest_id = :questid AND status = 1 ORDER BY completion_date_first ASC";
 		$params = array(":questid" => $QuestId);
 		$qh = $dbh->prepare($sql);
 		$qexec = $qh->execute($params);
 		$players = $qh->fetchAll(PDO::FETCH_ASSOC);
 		$qh = null;
+		// Format the players' times
+		foreach ($players as $key => $player) {
+			$tmpTime = gameTimeToDateInterval($player["firstTime"]);
+			if ($tmpTime->h >= 1) {
+				$players[$key]["firstTime"] = "more than 1 hour";
+			} else {
+				$players[$key]["firstTime"] = $tmpTime->format("%I:%S.").substr($tmpTime->f, 0, 3);
+			}
+			$tmpTime = gameTimeToDateInterval($player["bestTime"]);
+			if ($tmpTime->h >= 1) {
+				$players[$key]["bestTime"] = "more than 1 hour";
+			} else {
+				$players[$key]["bestTime"] = $tmpTime->format("%I:%S.").substr($tmpTime->f, 0, 3);
+			}
+		}
 		// Return the results
 		$playersList = array("Players" => $players,
 							 "QuestShortDesc" => ($QuestInfo["description_short"] != null) ? htmlentities($QuestInfo["description_short"], ENT_XML1) : "",

Main.php

@@ -124,6 +124,8 @@
 			#Struct SPlayer {
 				Text login;
 				Text nickname;
+				Text firstTime;
+				Text bestTime;
 			}
 			#Struct SBoardJsonResponse {
 				SPlayer[] Players;
@@ -177,12 +179,14 @@
 				declare persistent Text[][Integer] Pe_LocalTokensIds for Map;
 				declare persistent Text[][Integer] Pe_PlayerPos for Map;
 				declare persistent Integer[Integer] P_PlayerRaceStartTime for Map;
+				declare persistent Integer[Integer] P_PlayerQuestStartTime for Map;
 				declare persistent Text[Integer] P_QuestMapUid for Map;
 				
 				Per_LocalTokensCollected[G_QuestId] = [];
 				Pe_LocalTokensIds[G_QuestId] = [];
 				Pe_PlayerPos[G_QuestId] = [];
 				P_PlayerRaceStartTime[G_QuestId] = 0;
+				P_PlayerQuestStartTime[G_QuestId] = 0;
 				P_QuestMapUid[G_QuestId] = "";
 			}
 			
@@ -204,9 +208,9 @@
 				if (nbPlayers >= 1) {
 					declare Text QuestTitleToDisplay = TextLib::Replace(QuestTitleList, "[count]", nbPlayers ^ " " ^ PluralPlayers);
 					Message.SetText(Message.Value ^ QuestTitleToDisplay ^ "\n");
-					if (CurPage == 1) Message.SetText(Message.Value ^ "$iNote: This list is cached 10 minutes.$z\n");
+					if (CurPage == 1) Message.SetText(Message.Value ^ "$nNote: This list is cached 10 minutes, ordered by first completion date.$z\n");
 				} else {
-					Message.SetText(Message.Value ^ QuestTitleEmptyList ^ "\n$iNote: This list is cached 10 minutes.$z");
+					Message.SetText(Message.Value ^ QuestTitleEmptyList ^ "\n$nNote: This list is cached 10 minutes.$z");
 				}
 				for(i, StartPos, MaxLimit)
 				{
@@ -219,7 +223,7 @@
 					{
 						declare Text RankDisplay = TextLib::ToText(i+1);
 						if (i < 9) RankDisplay = "0" ^ TextLib::ToText(i+1);
-						Message.SetText(Message.Value ^ "\t\t\t\t\t\t\t$fff#" ^ RankDisplay ^ ":$g\t\t" ^ playersList[i].nickname ^ "$z $fff(" ^ playersList[i].login ^ ")\n");
+						Message.SetText(Message.Value ^ "$fff#" ^ RankDisplay ^ ":$g\t" ^ playersList[i].nickname ^ "$z $fff(" ^ playersList[i].login ^ ") in " ^ playersList[i].firstTime ^ " (PB: " ^ playersList[i].bestTime ^ ")\n");
 					}
 				}
 			}
@@ -261,6 +265,7 @@
 				declare persistent Text[][Integer] Pe_LocalTokensIds for Map;
 				declare persistent Text[][Integer] Pe_PlayerPos for Map;
 				declare persistent Integer[Integer] P_PlayerRaceStartTime for Map;
+				declare persistent Integer[Integer] P_PlayerQuestStartTime for Map;
 				declare persistent Text[Integer] P_QuestMapUid for Map;
 				declare persistent Boolean DebugMode for Map;
 				G_QuestId = '.htmlentities($QuestId, ENT_XML1).';
@@ -346,6 +351,7 @@
 												if (P_QuestMapUid[G_QuestId] == "") P_QuestMapUid[G_QuestId] = "'.htmlentities($QuestInfo["map_uid"], ENT_XML1).'";
 												if (DebugMode) log("MapUid for quest " ^ TextLib::ToText(G_QuestId) ^ " set to: " ^ P_QuestMapUid[G_QuestId]);
 												P_PlayerRaceStartTime[G_QuestId] = GUIPlayer.'.$startTimeVar.';
+												P_PlayerQuestStartTime[G_QuestId] = GameTime;
 												
 												// Check if the MapUid matches
 												if (P_QuestMapUid[G_QuestId] != Map.MapInfo.MapUid) {
@@ -382,7 +388,7 @@
 													}
 													else
 													{
-														Message.SetText(QuestFullDesc ^ "\n\nHave fun!\n\nNote: You need to complete the quest in the same race from where you started it. If you restart (e.g. by pressing del), you\'ll need to start the quest again. Several quests can be done in the same race.");
+														Message.SetText(QuestFullDesc ^ "\n\nHave fun!\n\n$nNote: You need to complete the quest in the same race from where you started it. If you restart (e.g. by pressing del), you\'ll need to start the quest again. Several quests can be done in the same race.$z");
 													}
 													
 													// Log all tokens for quest if debug activated
@@ -440,6 +446,7 @@
 							if (P_QuestMapUid[G_QuestId] == "") P_QuestMapUid[G_QuestId] = "'.htmlentities($QuestInfo["map_uid"], ENT_XML1).'";
 							if (DebugMode) log("MapUid for quest " ^ TextLib::ToText(G_QuestId) ^ " set to: " ^ P_QuestMapUid[G_QuestId]);
 							P_PlayerRaceStartTime[G_QuestId] = GUIPlayer.'.$startTimeVar.';
+							P_PlayerQuestStartTime[G_QuestId] = GameTime;
 							
 							// Check if the MapUid matches
 							if (P_QuestMapUid[G_QuestId] != Map.MapInfo.MapUid) {
@@ -506,9 +513,12 @@
 								// Log all tokens for quest if debug activated
 								declare Text Pe_PlayerPosString = LogMissingTokens();
 								
+								// Get quest completion time
+								declare Integer QuestCompletionTime = GameTime - P_PlayerQuestStartTime[G_QuestId];
+								
 								declare CHttpRequest request;
 								if (DebugMode) log("Quest " ^ TextLib::ToText(G_QuestId) ^ " completed. Processing...");
-								request = Http.CreateGet("'.$urlToRequest.'UpdateQuest.php?QuestId=" ^ TextLib::ToText(G_QuestId) ^ "&Login=" ^ LocalUser.Login ^ "&UserName=" ^ LocalUser.Name ^ "&Positions=" ^ TextLib::URLEncode(Pe_PlayerPosString) ^ "&MapUid=" ^ P_QuestMapUid[G_QuestId] ^ "&" ^ Now);
+								request = Http.CreateGet("'.$urlToRequest.'UpdateQuest.php?QuestId=" ^ TextLib::ToText(G_QuestId) ^ "&Login=" ^ LocalUser.Login ^ "&UserName=" ^ LocalUser.Name ^ "&Positions=" ^ TextLib::URLEncode(Pe_PlayerPosString) ^ "&MapUid=" ^ P_QuestMapUid[G_QuestId] ^ "&Time=" ^ TextLib::ToText(QuestCompletionTime) ^ "&" ^ Now);
 								clearPersistentData();
 								wait(request.IsCompleted);
 								if (DebugMode) {

UpdateQuest.php

@@ -16,6 +16,7 @@
 	$UserName = filter_input(INPUT_GET, 'UserName');
 	$Positions = urldecode(filter_input(INPUT_GET, 'Positions'));
 	$MapUid = filter_input(INPUT_GET, 'MapUid');
+	$Time = intval(filter_input(INPUT_GET, 'Time'));
 
 	// Check the player already finished or not
 	$sql = "SELECT COUNT(*) FROM players WHERE quest_id = :questid AND login = :login";
@@ -24,9 +25,24 @@
 	$qh = $dbh->prepare($sql);
 	$qexec = $qh->execute($params);
 	$alreadyFinished = $qh->fetchColumn();
+	
+	$processingRequired = false; // See if we need to either insert completion or update best time
+	
+	// Get completion info if the player already finished, see if the completime time is better
+	if ($alreadyFinished == 1) {
+		$sql = "SELECT completion_time_best FROM players WHERE quest_id = :questid AND login = :login";
+		$params = array(":questid" => $QuestId,
+						":login" => $Login);
+		$qh = $dbh->prepare($sql);
+		$qexec = $qh->execute($params);
+		$bestTime = $qh->fetchColumn();
+		if ($bestTime > $Time) $processingRequired = true;
+	} else {
+		$processingRequired = true;
+	}
 
-	// Player never finished yet, it's the first time, starting the checks
-	if($alreadyFinished == 0) {
+	// Player never finished yet (first time) or best time beaten, starting the checks
+	if($processingRequired == true) {
 		// MapUid check //
 		// Quest info are cached for 1h
 		$cacheId = "tm2ml_board_q".$QuestId."_info";
@@ -102,25 +118,34 @@
 
 		if ($tokensPassed == count($tokens)) $checkPassed = true;
 
-		// Check OK, insert completion in db
+		// Check OK, insert completion in db for a first time, update otherwise
 		if ($checkPassed) {
-			$sql = "INSERT INTO players (quest_id, login, nickname) VALUES (:questid, :login, :nickname)";
+			if ($alreadyFinished == 0) {
+				$sql = "INSERT INTO players (quest_id, login, nickname, completion_time_first, completion_time_best) VALUES (:questid, :login, :nickname, :time, :time)";
+			} else {
+				$sql = "UPDATE players SET nickname = :nickname, completion_date_best = NOW(), completion_time_best = :time WHERE quest_id = :questid AND login = :login";
+			}
 			$params = array(":login" => $Login,
 							":questid" => $QuestId,
-							":nickname" => $UserName);
+							":nickname" => $UserName,
+							":time" => $Time);
 			$qh = $dbh->prepare($sql);
 			$qexec = $qh->execute($params);
 			$qh = null;
 			if ($qexec) {
-				echo "Congrats, you completed this quest!";
+				if ($alreadyFinished == 0) {
+					echo "Congrats, you completed this quest!";
+				} else {
+					echo "Congrats, you beat your best time for this quest!";
+				}
 			} else {
 				echo "An error occured while processing your completion, sorry :/. Error: ".htmlentities($qh->errorInfo()[2], ENT_XML1)." (s".intval($qh->errorInfo()[0])."d".$qh->errorInfo()[1].")";
 			}
 		} else {
 			echo "Sorry, seems like you didn't collect all the tokens or an error occured.";
 		}
 	} else {
-		echo "You already completed this quest, hope you enjoyed!";
+		echo "You already completed this quest and didn't beat your best time, hope you still enjoyed!";
 	}
 
 } else {

_private/migrating_v1003_to_v1010.sql

@@ -0,0 +1,4 @@
+ALTER TABLE `players` CHANGE `completion_date` `completion_date_first` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP; 
+ALTER TABLE `players` ADD `completion_date_best` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP AFTER `completion_date_first`, ADD `completion_time_first` INT NOT NULL AFTER `completion_date_best`, ADD `completion_time_best` INT NOT NULL AFTER `completion_time_first`; 
+
+-- You'll need to update the completion times yourself if values already exist in the table

_private/tm2ml_sidequests.sql

@@ -3,9 +3,9 @@
 -- https://www.phpmyadmin.net/
 --
 -- Hôte : localhost
--- Généré le :  jeu. 14 nov. 2019 à 11:32
+-- Généré le :  Dim 24 nov. 2019 à 20:22
 -- Version du serveur :  10.3.17-MariaDB-0+deb10u1-log
--- Version de PHP :  7.3.9-1~deb10u1
+-- Version de PHP :  7.3.11-1~deb10u1
 
 SET SQL_MODE = "NO_AUTO_VALUE_ON_ZERO";
 SET AUTOCOMMIT = 0;
@@ -32,7 +32,10 @@ CREATE TABLE `players` (
   `login` varchar(50) COLLATE utf8mb4_unicode_ci NOT NULL COMMENT 'Login ManiaPlanet',
   `nickname` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL COMMENT 'In-game NickName',
   `quest_id` smallint(5) UNSIGNED NOT NULL,
-  `completion_date` datetime NOT NULL DEFAULT current_timestamp(),
+  `completion_date_first` datetime NOT NULL DEFAULT current_timestamp(),
+  `completion_date_best` datetime NOT NULL DEFAULT current_timestamp(),
+  `completion_time_first` int(11) NOT NULL COMMENT 'Completion time for the first time (in milliseconds)',
+  `completion_time_best` int(11) NOT NULL COMMENT 'Best completion time (in milliseconds)',
   `status` tinyint(1) UNSIGNED NOT NULL DEFAULT 1 COMMENT '1 (default) = OK, 0 = NOK (cheat, ...)'
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='Players who finished a quest';
 

includes/functions.php

@@ -19,4 +19,18 @@ function isClientName($clientName) {
 // Check if a string starts with $needle
 function startsWith($haystack, $needle) {
     return ($needle === "" || strpos($haystack, $needle) === 0);
+}
+
+// Convert a time in milliseconds as a DateInterval
+function gameTimeToDateInterval($time) {
+	$seconds = floor($time / 1000);
+	$dateInterval = new \DateInterval('P0D');
+	$dateInterval->y = floor($seconds / (365 * 24 * 60 * 60));
+	$dateInterval->m = floor(($seconds - ($dateInterval->y * 365 * 24 * 60 * 60)) / (30 * 24 * 60 * 60));
+	$dateInterval->d = floor(($seconds - ($dateInterval->m * 30 * 24 * 60 * 60)) / (24 * 60 * 60));
+	$dateInterval->h = floor(($seconds - ($dateInterval->d * 24 * 60 * 60)) / (60 * 60));
+	$dateInterval->i = floor(($seconds - ($dateInterval->h * 60 * 60)) / (60));
+	$dateInterval->s = floor($seconds % 60);
+	$dateInterval->f = $time - ($seconds * 1000);
+	return $dateInterval;
 }