From 7470e88624820400e15883155aa7bbbb216a9c1c Mon Sep 17 00:00:00 2001
From: elexis <elexis@wildfiregames.com>
Date: Wed, 17 Aug 2016 15:17:43 +0000
Subject: [PATCH] Always save the replay metadata (summary screen info) when
 ending the application. Patch by Imarok, fixes #4020.

This was SVN commit r18613.
---
 .../gui/common/functions_global_object.js     | 13 ++++++++++++
 .../data/mods/public/gui/session/session.js   | 15 ++------------
 .../mods/public/gui/structree/structree.xml   |  1 +
 source/ps/GameSetup/GameSetup.cpp             |  5 +++++
 source/ps/VisualReplay.cpp                    | 20 +++++++++++++------
 source/ps/VisualReplay.h                      |  4 ++--
 .../ps/scripting/JSInterface_VisualReplay.cpp |  6 ------
 .../ps/scripting/JSInterface_VisualReplay.h   |  3 +--
 8 files changed, 38 insertions(+), 29 deletions(-)

diff --git a/binaries/data/mods/public/gui/common/functions_global_object.js b/binaries/data/mods/public/gui/common/functions_global_object.js
index 88b7e08267..a28a8d1ada 100644
--- a/binaries/data/mods/public/gui/common/functions_global_object.js
+++ b/binaries/data/mods/public/gui/common/functions_global_object.js
@@ -165,3 +165,16 @@ function displayGamestateNotifications()
 
 	setTimeout(displayGamestateNotifications, 1000);
 }
+
+/**
+ * Also called from the C++ side when ending the game.
+ */
+function getReplayMetadata()
+{
+	let extendedSimState = Engine.GuiInterfaceCall("GetExtendedSimulationState");
+	return {
+		"timeElapsed" : extendedSimState.timeElapsed,
+		"playerStates": extendedSimState.players,
+		"mapSettings": Engine.GetInitAttributes().settings
+	};
+}
diff --git a/binaries/data/mods/public/gui/session/session.js b/binaries/data/mods/public/gui/session/session.js
index 35af7a752e..c34dfa41c1 100644
--- a/binaries/data/mods/public/gui/session/session.js
+++ b/binaries/data/mods/public/gui/session/session.js
@@ -517,23 +517,12 @@ function resignGame(leaveGameAfterResign)
  */
 function leaveGame(willRejoin)
 {
-	let extendedSimState = Engine.GuiInterfaceCall("GetExtendedSimulationState");
-	let simData = {
-		"timeElapsed" : extendedSimState.timeElapsed,
-		"playerStates": extendedSimState.players,
-		"mapSettings": g_GameAttributes.settings
-	};
-
-	if (!g_IsReplay)
-		Engine.SaveReplayMetadata(JSON.stringify(simData));
-
-	if (!willRejoin &&
-	    simData.playerStates[Engine.GetPlayerID()] &&
-	    simData.playerStates[Engine.GetPlayerID()].state == "active")
+	if (!willRejoin && !g_IsObserver)
 		resignGame(true);
 
 	// Before ending the game
 	let replayDirectory = Engine.GetCurrentReplayDirectory();
+	let simData = getReplayMetadata();
 
 	Engine.EndGame();
 
diff --git a/binaries/data/mods/public/gui/structree/structree.xml b/binaries/data/mods/public/gui/structree/structree.xml
index 4165e1ca52..3305df4ca2 100644
--- a/binaries/data/mods/public/gui/structree/structree.xml
+++ b/binaries/data/mods/public/gui/structree/structree.xml
@@ -2,6 +2,7 @@
 
 <objects>
 	<script file="gui/common/functions_civinfo.js"/>
+	<script file="gui/common/functions_global_object.js"/>
 	<script file="gui/common/functions_utility.js"/>
 	<script file="gui/common/tooltips.js"/>
 	<script file="gui/structree/structree.js"/>
diff --git a/source/ps/GameSetup/GameSetup.cpp b/source/ps/GameSetup/GameSetup.cpp
index f875144d40..8891ba26da 100644
--- a/source/ps/GameSetup/GameSetup.cpp
+++ b/source/ps/GameSetup/GameSetup.cpp
@@ -78,6 +78,7 @@
 #include "ps/UserReport.h"
 #include "ps/Util.h"
 #include "ps/VideoMode.h"
+#include "ps/VisualReplay.h"
 #include "ps/World.h"
 
 #include "renderer/Renderer.h"
@@ -701,6 +702,10 @@ static void ShutdownSDL()
 
 void EndGame()
 {
+	if (g_Game && g_Game->IsGameStarted() && !g_Game->IsVisualReplay() &&
+	    g_AtlasGameLoop && !g_AtlasGameLoop->running)
+		VisualReplay::SaveReplayMetadata(g_GUI->GetActiveGUI()->GetScriptInterface().get());
+
 	SAFE_DELETE(g_NetClient);
 	SAFE_DELETE(g_NetServer);
 	SAFE_DELETE(g_Game);
diff --git a/source/ps/VisualReplay.cpp b/source/ps/VisualReplay.cpp
index a69bf27d88..a2c6c38e27 100644
--- a/source/ps/VisualReplay.cpp
+++ b/source/ps/VisualReplay.cpp
@@ -134,7 +134,7 @@ inline int goBackToLineBeginning(std::istream* replayStream, const CStr& fileNam
  *
  * @return seconds or -1 on error
  */
-inline int getReplayDuration(std::istream *replayStream, const CStr& fileName, const u64& fileSize)
+inline int getReplayDuration(std::istream* replayStream, const CStr& fileName, const u64& fileSize)
 {
 	CStr type;
 
@@ -292,20 +292,28 @@ JS::Value VisualReplay::GetReplayAttributes(ScriptInterface::CxPrivate* pCxPriva
 	return attribs;
 }
 
-// TODO: enhancement: how to save the data if the process is killed? (case SDL_QUIT in main.cpp)
-void VisualReplay::SaveReplayMetadata(const CStrW& data)
+void VisualReplay::SaveReplayMetadata(ScriptInterface* scriptInterface)
 {
-	// TODO: enhancement: use JS::HandleValue similar to SaveGame
-	if (!g_Game)
+	JSContext* cx = scriptInterface->GetContext();
+	JSAutoRequest rq(cx);
+
+	JS::RootedValue metadata(cx);
+	JS::RootedValue global(cx, scriptInterface->GetGlobalObject());
+
+	if (!scriptInterface->CallFunction(global, "getReplayMetadata", &metadata))
+	{
+		LOGERROR("Could not save replay metadata!");
 		return;
+	}
 
 	// Get the directory of the currently active replay
 	const OsPath fileName = g_Game->GetReplayLogger().GetDirectory() / L"metadata.json";
 	CreateDirectories(fileName.Parent(), 0700);
 
 	std::ofstream stream (fileName.string8().c_str(), std::ofstream::out | std::ofstream::trunc);
-	stream << utf8_from_wstring(data);
+	stream << scriptInterface->StringifyJSON(&metadata, false);
 	stream.close();
+	debug_printf("Saved replay metadata to %s\n", fileName.string8().c_str());
 }
 
 bool VisualReplay::HasReplayMetadata(const CStrW& directoryName)
diff --git a/source/ps/VisualReplay.h b/source/ps/VisualReplay.h
index 56b9b8f534..3c061757a1 100644
--- a/source/ps/VisualReplay.h
+++ b/source/ps/VisualReplay.h
@@ -1,4 +1,4 @@
-/* Copyright (C) 2015 Wildfire Games.
+/* Copyright (C) 2016 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
@@ -81,7 +81,7 @@ JS::Value GetReplayMetadata(ScriptInterface::CxPrivate* pCxPrivate, const CStrW&
 /**
  * Saves the metadata from the session to metadata.json
  */
-void SaveReplayMetadata(const CStrW& data);
+void SaveReplayMetadata(ScriptInterface* scriptInterface);
 
 }
 
diff --git a/source/ps/scripting/JSInterface_VisualReplay.cpp b/source/ps/scripting/JSInterface_VisualReplay.cpp
index 1804b1e0af..dde841d08a 100644
--- a/source/ps/scripting/JSInterface_VisualReplay.cpp
+++ b/source/ps/scripting/JSInterface_VisualReplay.cpp
@@ -53,11 +53,6 @@ JS::Value JSI_VisualReplay::GetReplayMetadata(ScriptInterface::CxPrivate* pCxPri
 	return VisualReplay::GetReplayMetadata(pCxPrivate, directoryName);
 }
 
-void JSI_VisualReplay::SaveReplayMetadata(ScriptInterface::CxPrivate* UNUSED(pCxPrivate), const CStrW& data)
-{
-	VisualReplay::SaveReplayMetadata(data);
-}
-
 void JSI_VisualReplay::RegisterScriptFunctions(ScriptInterface& scriptInterface)
 {
 	scriptInterface.RegisterFunction<JS::Value, &GetReplays>("GetReplays");
@@ -66,5 +61,4 @@ void JSI_VisualReplay::RegisterScriptFunctions(ScriptInterface& scriptInterface)
 	scriptInterface.RegisterFunction<JS::Value, CStrW, &GetReplayAttributes>("GetReplayAttributes");
 	scriptInterface.RegisterFunction<JS::Value, CStrW, &GetReplayMetadata>("GetReplayMetadata");
 	scriptInterface.RegisterFunction<bool, CStrW, &HasReplayMetadata>("HasReplayMetadata");
-	scriptInterface.RegisterFunction<void, CStrW, &SaveReplayMetadata>("SaveReplayMetadata");
 }
diff --git a/source/ps/scripting/JSInterface_VisualReplay.h b/source/ps/scripting/JSInterface_VisualReplay.h
index a1ff5d8e02..2c97a82ef5 100644
--- a/source/ps/scripting/JSInterface_VisualReplay.h
+++ b/source/ps/scripting/JSInterface_VisualReplay.h
@@ -1,4 +1,4 @@
-/* Copyright (C) 2015 Wildfire Games.
+/* Copyright (C) 2016 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
@@ -29,7 +29,6 @@ namespace JSI_VisualReplay
 	JS::Value GetReplayAttributes(ScriptInterface::CxPrivate* pCxPrivate, const CStrW& directoryName);
 	bool HasReplayMetadata(ScriptInterface::CxPrivate* pCxPrivate, const CStrW& directoryName);
 	JS::Value GetReplayMetadata(ScriptInterface::CxPrivate* pCxPrivate, const CStrW& directoryName);
-	void SaveReplayMetadata(ScriptInterface::CxPrivate* pCxPrivate, const CStrW& data);
 	void RegisterScriptFunctions(ScriptInterface& scriptInterface);
 }