Ticket #3255: t3255_prevent_replay_overwrites_v4.patch

source/ps/Replay.cpp

@@ -22 +22 @@
 #include "graphics/TerrainTextureManager.h"
 #include "lib/timer.h"
 #include "lib/file/file_system.h"
 #include "lib/res/h_mgr.h"
 #include "lib/tex/tex.h"
+#include "ps/CLogger.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 "ps/VisualReplay.h"
 #include "scriptinterface/ScriptInterface.h"
 #include "scriptinterface/ScriptStats.h"
 #include "simulation2/Simulation2.h"
 #include "simulation2/helpers/SimulationCommand.h"
 
+#include <ctime>
 #include <sstream>
 #include <fstream>
 #include <iomanip>
 
-#if MSC_VERSION
-#include <process.h>
-#define getpid _getpid // use the non-deprecated function name
-#endif
-
 static std::string Hexify(const std::string& s)
 {
     std::stringstream str;
     str << std::hex;
     for (size_t i = 0; i < s.size(); ++i)
@@ -63 +60 @@
     delete m_Stream;
 }
 
 void CReplayLogger::StartGame(JS::MutableHandleValue attribs)
 {
+    const time_t timestamp = std::time(nullptr);
+
     // Add timestamp, since the file-modification-date can change
-    m_ScriptInterface.SetProperty(attribs, "timestamp", std::to_string(std::time(nullptr)));
+    m_ScriptInterface.SetProperty(attribs, "timestamp", std::to_string(timestamp));
 
     // 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;
+    // Construct directory name (for example 2015-11-02_001)
+    const struct tm* now = localtime(&timestamp);
+    const CStr directoryFormat = "%04d-%02d-%02d_%03d";
+    char directory[directoryFormat.length()];
+    for (int i=1; i<=1000; ++i)
+    {
+        sprintf(directory, directoryFormat.c_str(), now->tm_year + 1900, now->tm_mon + 1, now->tm_mday, i);
+
+        m_Directory = VisualReplay::GetDirectoryName() / wstring_from_utf8(CStr(directory));
+
+        if (!DirectoryExists(m_Directory) && !FileExists(m_Directory))
+            break;
+
+        if (i==1000)
+            LOGERROR("Overwriting %s", m_Directory.string8());
+    }
 
-    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";
 }

source/ps/VisualReplay.cpp

@@ -39 +39 @@
  */
 const bool debugParser = false;
 
 OsPath VisualReplay::GetDirectoryName()
 {
-    return OsPath(psLogDir() / L"sim_log");
+    return OsPath(psLogDir() / (L"replays_v" + wstring_from_utf8(engine_version)));
 }
 
 JS::Value VisualReplay::GetReplays(ScriptInterface& scriptInterface)
 {
     TIMER(L"GetReplays");

source/simulation2/Simulation2.cpp

@@ -39 +39 @@
 #include "ps/ConfigDB.h"
 #include "ps/Filesystem.h"
 #include "ps/Loader.h"
 #include "ps/Profile.h"
 #include "ps/Pyrogenesis.h"
+#include "ps/VisualReplay.h"
 #include "ps/XML/Xeromyces.h"
 
 #include <iomanip>
 
 #if MSC_VERSION
@@ -553 +554 @@
 
     std::stringstream pid;
     pid << getpid();
     std::stringstream name;\
     name << std::setw(5) << std::setfill('0') << m_TurnNumber << ".txt";
-    OsPath path = psLogDir() / "sim_log" / pid.str() / name.str();
+    OsPath path = VisualReplay::GetDirectoryName() / "oos_log" / name.str();
     CreateDirectories(path.Parent(), 0700);
     std::ofstream file (OsString(path).c_str(), std::ofstream::out | std::ofstream::trunc);
 
     file << "State hash: " << std::hex;
     std::string hashRaw;