Ticket #4020: 4020_altf4_v2.1.patch

binaries/data/mods/public/gui/common/functions_global_object.js

@@ -165 +165 @@
 
     setTimeout(displayGamestateNotifications, 1000);
 }
+
+/*
+ * The simData is used for the summary and as replay metadata
+ */
+function getSimData()
+{
+    let extendedSimState = Engine.GuiInterfaceCall("GetExtendedSimulationState");
+    return {
+        "timeElapsed" : extendedSimState.timeElapsed,
+        "playerStates": extendedSimState.players,
+        "mapSettings": Engine.GetInitAttributes().settings
+    };
+}

binaries/data/mods/public/gui/session/session.js

@@ -517 +517 @@
  */
 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")
+        g_Players[Engine.GetPlayerID()] &&
+        g_Players[Engine.GetPlayerID()].state == "active")
         resignGame(true);
 
     // Before ending the game
     let replayDirectory = Engine.GetCurrentReplayDirectory();
 
+    let simData = getSimData();
+
     Engine.EndGame();
 
     if (g_IsController && Engine.HasXmppClient())

binaries/data/mods/public/gui/structree/structree.xml

@@ -1 +1 @@
 <?xml version="1.0" encoding="utf-8"?>
 
 <objects>
+    <script file="gui/common/functions_global_object.js"/>
     <script file="gui/common/functions_civinfo.js"/>
     <script file="gui/common/functions_utility.js"/>
     <script file="gui/common/tooltips.js"/>

source/ps/GameSetup/GameSetup.cpp

@@ -78 +78 @@
 #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 +702 @@
 
 void EndGame()
 {
+    if (g_Game != NULL && !g_Game->IsVisualReplay())
+        VisualReplay::SaveReplayMetadata(g_GUI->GetActiveGUI()->GetScriptInterface().get());
+
     SAFE_DELETE(g_NetClient);
     SAFE_DELETE(g_NetServer);
     SAFE_DELETE(g_Game);

source/ps/scripting/JSInterface_VisualReplay.cpp

@@ -53 +53 @@
     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 +61 @@
     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");
 }

source/ps/scripting/JSInterface_VisualReplay.h

@@ -1 @@
-/* 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 +29 @@
     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);
 }
 

source/ps/VisualReplay.cpp

@@ -134 +134 @@
  *
  * @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 +292 @@
     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)
         return;
+    
+    JSContext* cx = scriptInterface->GetContext();
+    JSAutoRequest rq(cx);
 
+    JS::RootedValue data(cx);
+    JS::RootedValue global(cx, scriptInterface->GetGlobalObject());
+
+    if (!scriptInterface->CallFunction(global, "getSimData", &data))
+    {
+        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(&data, false);
     stream.close();
+    debug_printf("Saved replay metadata to %s\n", fileName.string8().c_str());
 }
 
 bool VisualReplay::HasReplayMetadata(const CStrW& directoryName)

source/ps/VisualReplay.h

@@ -1 @@
-/* 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 +81 @@
 /**
  * Saves the metadata from the session to metadata.json
  */
-void SaveReplayMetadata(const CStrW& data);
+void SaveReplayMetadata(ScriptInterface* scriptInterface);
 
 }