Ticket #3359: t3359_move_engine_version_v1.patch

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

@@ -7 +7 @@
 {
     var dateTimeString = Engine.FormatMillisecondsIntoDateString(metadata.time*1000, translate("yyyy-MM-dd HH:mm:ss"));
     var dateString = sprintf(translate("\\[%(date)s]"), { date: dateTimeString });
     if (engineInfo)
     {
-        if (!hasSameVersion(metadata, engineInfo))
+        if (!hasSameSavegameVersion(metadata, engineInfo) || !hasSameEngineVersion(metadata, engineInfo))
             dateString = "[color=\"red\"]" + dateString + "[/color]";
         else if (!hasSameMods(metadata, engineInfo))
             dateString = "[color=\"orange\"]" + dateString + "[/color]";
     }
     if (metadata.description)
@@ -21 +21 @@
 }
 
 /**
  * Check the version compatibility between the saved game to be loaded and the engine
  */
-function hasSameVersion(metadata, engineInfo)
+function hasSameSavegameVersion(metadata, engineInfo)
 {
-    return (metadata.version_major == engineInfo.version_major);
+    return metadata.version_major == engineInfo.version_major;
+}
+
+/**
+ * Check the version compatibility between the saved game to be loaded and the engine
+ */
+function hasSameEngineVersion(metadata, engineInfo)
+{
+    return metadata.engine_version && metadata.engine_version == engineInfo.engine_version;
 }
 
 /**
  * Check the mod compatibility between the saved game to be loaded and the engine
  */
 function hasSameMods(metadata, engineInfo)
 {
-    if (!metadata.mods)         // only here for backwards compatibility with previous saved games
-        var gameMods = [];
-    else
-        var gameMods = metadata.mods;
-
-    if (gameMods.length != engineInfo.mods.length)
+    if (!metadata.mods || metadata.mods.length != engineInfo.mods.length)
         return false;
-    for (var i = 0; i < gameMods.length; ++i)
-        if (gameMods[i] != engineInfo.mods[i])
-            return false;
-    return true;
+    
+    return metadata.mods.every((mod, index) => mod == engineInfo.mods[index]);
 }

binaries/data/mods/public/gui/savedgames/load.js

@@ -38 +38 @@
     var gameLabel = gameSelection.list[gameSelection.selected];
     var metadata = gameMetadatas[gameSelection.selected];
 
     // check game compatibility before really loading it
     var engineInfo = Engine.GetEngineInfo();
-    if (!hasSameVersion(metadata, engineInfo) || !hasSameMods(metadata, engineInfo))
+    var sameMods = hasSameMods(metadata, engineInfo);
+    var sameEngineVersion = hasSameEngineVersion(metadata, engineInfo);
+    var sameSavegameVersion = hasSameSavegameVersion(metadata, engineInfo);
+    if (!sameEngineVersion || !sameSavegameVersion || !sameMods)
     {
         // version not compatible ... ask for confirmation
         var btCaptions = [translate("Yes"), translate("No")];
         var btCode = [function(){ reallyLoadGame(gameId); }, init];
         var message = translate("This saved game may not be compatible:");
-        if (!hasSameVersion(metadata, engineInfo))
-            message += "\n" + sprintf(translate("It needs 0 A.D. version %(requiredVersion)s, while you are running version %(currentVersion)s."), {
+
+        if (!sameEngineVersion)
+        {
+            if (metadata.engine_version)
+                message += "\n" + sprintf(translate("It needs 0 A.D. version %(requiredVersion)s, while you are running version %(currentVersion)s."), {
+                    requiredVersion: metadata.engine_version,
+                    currentVersion: engineInfo.engine_version
+                });
+            else
+                message += "\n" + translate("It needs an older version of 0 A.D.");
+        }
+        
+        if (!sameSavegameVersion)
+            message += "\n" + sprintf(translate("It needs 0 A.D. savegame version %(requiredVersion)s, while you are running version %(currentVersion)s."), {
                 requiredVersion: metadata.version_major,
                 currentVersion: engineInfo.version_major
             });
 
-        if (!hasSameMods(metadata, engineInfo))
+        if (!sameMods)
         {
             if (!metadata.mods)         // only for backwards compatibility with previous saved games
                 metadata.mods = [];
             if (metadata.mods.length == 0)
                 message += "\n" + sprintf(translate("It does not need any mod while you are running with \"%(currentMod)s\"."), {

source/lobby/XmppClient.cpp

@@ -22 +22 @@
 #include "glooxwrapper/glooxwrapper.h"
 #include "i18n/L10n.h"
 #include "lib/utf8.h"
 #include "ps/CLogger.h"
 #include "ps/ConfigDB.h"
+#include "ps/Pyrogenesis.h"
 #include "scriptinterface/ScriptInterface.h"
 
 //debug
 #if 1
 #define DbgXMPP(x)
@@ -95 +96 @@
     const int mechs = gloox::SaslMechAll ^ gloox::SaslMechPlain;
     m_client->setSASLMechanisms(mechs);
 
     m_client->registerConnectionListener(this);
     m_client->setPresence(gloox::Presence::Available, -1);
-    m_client->disco()->setVersion("Pyrogenesis", "0.0.19");
+    m_client->disco()->setVersion("Pyrogenesis", engine_version);
     m_client->disco()->setIdentity("client", "bot");
     m_client->setCompression(false);
 
     m_client->registerStanzaExtension(new GameListQuery());
     m_client->registerIqHandler(this, EXTGAMELISTQUERY);

source/ps/Pyrogenesis.cpp

@@ -22 +22 @@
 #include "Pyrogenesis.h"
 
 #include "lib/sysdep/sysdep.h"
 #include "lib/svn_revision.h"
 
+const char engine_version[] = "0.0.19";
+
 // convert contents of file <in_filename> from char to wchar_t and
 // append to <out> file.
 static void AppendAsciiFile(FILE* out, const OsPath& pathname)
 {
     FILE* in = sys_OpenFile(pathname, "rb");
@@ -52 +54 @@
 
 // for user convenience, bundle all logs into this file:
 void psBundleLogs(FILE* f)
 {
     fwprintf(f, L"SVN Revision: %ls\n\n", svn_revision);
+    fwprintf(f, L"Engine Version: %hs\n\n", engine_version);
 
     fwprintf(f, L"System info:\n\n");
     OsPath path1 = psLogDir()/"system_info.txt";
     AppendAsciiFile(f, path1);
     fwprintf(f, L"\n\n====================================\n\n");

source/ps/Pyrogenesis.h

@@ -24 +24 @@
 #ifndef INCLUDED_PYROGENESIS
 #define INCLUDED_PYROGENESIS
 
 #include "lib/os_path.h"
 
+extern const char engine_version[];
+
 extern void psBundleLogs(FILE* f); // set during InitVfs
 extern void psSetLogDir(const OsPath& logDir);  // set during InitVfs
 extern const OsPath& psLogDir();    // used by AppHooks and engine code when reporting errors
 
 #endif

source/ps/SavedGame.cpp

@@ -1 @@
-/* Copyright (C) 2014 Wildfire Games.
+/* Copyright (C) 2015 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 2 of the License, or
@@ -27 +27 @@
 #include "lib/utf8.h"
 #include "ps/CLogger.h"
 #include "ps/Filesystem.h"
 #include "ps/Game.h"
 #include "ps/Mod.h"
+#include "ps/Pyrogenesis.h"
 #include "scriptinterface/ScriptInterface.h"
 #include "simulation2/Simulation2.h"
 
 static const int SAVED_GAME_VERSION_MAJOR = 1; // increment on incompatible changes to the format
 static const int SAVED_GAME_VERSION_MINOR = 0; // increment on compatible changes to the format
@@ -84 +85 @@
     JS::RootedValue metadata(cx);
     JS::RootedValue initAttributes(cx, simulation.GetInitAttributes());
     simulation.GetScriptInterface().Eval("({})", &metadata);
     simulation.GetScriptInterface().SetProperty(metadata, "version_major", SAVED_GAME_VERSION_MAJOR);
     simulation.GetScriptInterface().SetProperty(metadata, "version_minor", SAVED_GAME_VERSION_MINOR);
+    simulation.GetScriptInterface().SetProperty(metadata, "engine_version", CStr(engine_version));
     simulation.GetScriptInterface().SetProperty(metadata, "mods", g_modsLoaded);
     simulation.GetScriptInterface().SetProperty(metadata, "time", (double)now);
     simulation.GetScriptInterface().SetProperty(metadata, "player", playerID);
     simulation.GetScriptInterface().SetProperty(metadata, "initAttributes", initAttributes);
 
@@ -298 +300 @@
     
     JS::RootedValue metainfo(cx); 
     scriptInterface.Eval("({})", &metainfo); 
     scriptInterface.SetProperty(metainfo, "version_major", SAVED_GAME_VERSION_MAJOR); 
     scriptInterface.SetProperty(metainfo, "version_minor", SAVED_GAME_VERSION_MINOR); 
-    scriptInterface.SetProperty(metainfo, "mods"         , g_modsLoaded);
+    scriptInterface.SetProperty(metainfo, "engine_version", CStr(engine_version));
+    scriptInterface.SetProperty(metainfo, "mods", g_modsLoaded);
     return metainfo;
 }