Ticket #3258: t3258_remember_replay_directory_and_save_metadata_v1.patch

source/ps/Replay.cpp

@@ -24 +24 @@
 #include "lib/file/file_system.h"
 #include "lib/res/h_mgr.h"
 #include "lib/tex/tex.h"
 #include "ps/Game.h"
 #include "ps/Loader.h"
+#include "ps/Mod.h"
 #include "ps/Profile.h"
 #include "ps/ProfileViewer.h"
+#include "ps/Pyrogenesis.h"
 #include "scriptinterface/ScriptInterface.h"
 #include "scriptinterface/ScriptStats.h"
 #include "simulation2/Simulation2.h"
 #include "simulation2/helpers/SimulationCommand.h"
 
@@ -61 +63 @@
     delete m_Stream;
 }
 
 void CReplayLogger::StartGame(JS::MutableHandleValue attribs)
 {
+    // Add timestamp, since the file-modification-date can change
+    m_ScriptInterface.SetProperty(attribs, "timestamp", std::time(nullptr));
+
+    // Add engine version and currently loaded mods for sanity checks when replaying
+    m_ScriptInterface.SetProperty(attribs, "engine_version", CStr(engine_version));
+    m_ScriptInterface.SetProperty(attribs, "mods", g_modsLoaded);
+
     // Construct the directory name based on the PID, to be relatively unique.
     // Append "-1", "-2" etc if we run multiple matches in a single session,
     // to avoid accidentally overwriting earlier logs.
-
     std::wstringstream name;
     name << getpid();
 
     static int run = -1;
     if (++run)
         name << "-" << run;
 
-    OsPath path = psLogDir() / L"sim_log" / name.str() / L"commands.txt";
-    CreateDirectories(path.Parent(), 0700);
-    m_Stream = new std::ofstream(OsString(path).c_str(), std::ofstream::out | std::ofstream::trunc);
+    m_Directory = psLogDir() / L"sim_log" / name.str();
+    CreateDirectories(m_Directory, 0700);
 
+    m_Stream = new std::ofstream(OsString(m_Directory / L"commands.txt").c_str(), std::ofstream::out | std::ofstream::trunc);
     *m_Stream << "start " << m_ScriptInterface.StringifyJSON(attribs, false) << "\n";
 }
 
 void CReplayLogger::Turn(u32 n, u32 turnLength, std::vector<SimulationCommand>& commands)
 {
@@ -101 +109 @@
         *m_Stream << "hash-quick " << Hexify(hash) << "\n";
     else
         *m_Stream << "hash " << Hexify(hash) << "\n";
 }
 
+OsPath CReplayLogger::GetDirectory() const
+{
+    return m_Directory;
+}
+
 ////////////////////////////////////////////////////////////////
 
 CReplayPlayer::CReplayPlayer() :
     m_Stream(NULL)
 {

source/ps/Replay.h

@@ -45 +45 @@
 
     /**
      * Optional hash of simulation state (for sync checking).
      */
     virtual void Hash(const std::string& hash, bool quick) = 0;
+
+    /**
+     * Remember the directory containing the commands.txt file, so that we can save additional files to it.
+     */
+    virtual OsPath GetDirectory() const = 0;
 };
 
 /**
  * Implementation of IReplayLogger that simply throws away all data.
  */
@@ -56 +61 @@
 {
 public:
     virtual void StartGame(JS::MutableHandleValue UNUSED(attribs)) { }
     virtual void Turn(u32 UNUSED(n), u32 UNUSED(turnLength), std::vector<SimulationCommand>& UNUSED(commands)) { }
     virtual void Hash(const std::string& UNUSED(hash), bool UNUSED(quick)) { }
+    virtual OsPath GetDirectory() const { return OsPath(); }
 };
 
 /**
  * Implementation of IReplayLogger that saves data to a file in the logs directory.
  */
@@ -71 +77 @@
     ~CReplayLogger();
 
     virtual void StartGame(JS::MutableHandleValue attribs);
     virtual void Turn(u32 n, u32 turnLength, std::vector<SimulationCommand>& commands);
     virtual void Hash(const std::string& hash, bool quick);
+    virtual OsPath GetDirectory() const;
 
 private:
     ScriptInterface& m_ScriptInterface;
     std::ostream* m_Stream;
+    OsPath m_Directory;
 };
 
 /**
  * Replay log replayer. Runs the log with no graphics and dumps some info to stdout.
  */