Merge pull request #474 from cortex-command-community/cf/468-add-proper-semantic-version-comparison-to-check-mod-compatibility

Add proper semantic version comparison to check mod compatibility

Author: garethyr

CHANGELOG.md

@@ -10,6 +10,18 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 </details>
 
 <details><summary><b>Changed</b></summary>
+
+- Unofficial modules (mods) now use [Semantic Versioning](https://semver.org/) to check which version of the game they target.  
+	As such, the `Index.ini` property `SupportedGameVersion` must now be a valid semantic version number. The game version has also been updated to match this standard.  
+
+	The `SupportedGameVersion` version number must be of the form `X.Y.z`, where:  
+
+	`X` matches the major version of the game,  
+	`Y` is the minimum minor version of the game the mod requires,  
+	`z` is the patch number, which is currently not enforced.  
+
+  Mods published for any development builds must match that development version exactly.
+
 </details>
 
 <details><summary><b>Fixed</b></summary>

Menus/MainMenuGUI.cpp

@@ -7,6 +7,8 @@
 #include "SettingsMan.h"
 #include "ConsoleMan.h"
 
+#include "GameVersion.h"
+
 #include "GUI.h"
 #include "AllegroScreen.h"
 #include "GUIInputWrapper.h"
@@ -114,7 +116,7 @@ namespace RTE {
 		}
 
 		m_VersionLabel = dynamic_cast<GUILabel *>(m_MainMenuScreenGUIControlManager->GetControl("VersionLabel"));
-		m_VersionLabel->SetText("Community Project\n" + std::string(c_MajorGameVersion) + std::string(c_MinorGameVersion));
+		m_VersionLabel->SetText("Community Project\nv" + c_GameVersion.str());
 		m_VersionLabel->SetPositionAbs(10, g_WindowMan.GetResY() - m_VersionLabel->GetTextHeight() - 5);
 	}
 

RTEA.vcxproj

@@ -621,6 +621,7 @@
     <ClInclude Include="System\Constants.h" />
     <ClInclude Include="System\Controller.h" />
     <ClInclude Include="System\Entity.h" />
+    <ClInclude Include="System\GameVersion.h" />
     <ClInclude Include="System\GenericSavedData.h" />
     <ClInclude Include="System\InputMapping.h" />
     <ClInclude Include="System\InputScheme.h" />
@@ -629,6 +630,8 @@
     <ClInclude Include="System\Gamepad.h" />
     <ClInclude Include="Menus\InventoryMenuGUI.h" />
     <ClInclude Include="System\PieQuadrant.h" />
+    <ClInclude Include="System\Semver200\semver200.h" />
+    <ClInclude Include="System\Semver200\version.h" />
     <ClInclude Include="System\SpatialPartitionGrid.h" />
     <ClInclude Include="System\StandardIncludes.h" />
     <ClInclude Include="System\Box.h" />
@@ -854,6 +857,9 @@
     <ClCompile Include="System\InputScheme.cpp" />
     <ClCompile Include="System\GraphicalPrimitive.cpp" />
     <ClCompile Include="System\PieQuadrant.cpp" />
+    <ClCompile Include="System\Semver200\Semver200_comparator.cpp" />
+    <ClCompile Include="System\Semver200\Semver200_modifier.cpp" />
+    <ClCompile Include="System\Semver200\Semver200_parser.cpp" />
     <ClCompile Include="System\Serializable.cpp" />
     <ClCompile Include="System\SpatialPartitionGrid.cpp" />
     <ClCompile Include="System\StandardIncludes.cpp">
@@ -987,6 +993,7 @@
   </ItemGroup>
   <ItemGroup>
     <None Include="cpp.hint" />
+    <None Include="System\Semver200\version.inl" />
   </ItemGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
   <ImportGroup Label="ExtensionTargets">

RTEA.vcxproj.filters

@@ -28,6 +28,9 @@
     <Filter Include="Lua">
       <UniqueIdentifier>{ac503e37-087b-40b8-b1b8-427ab55a4f9e}</UniqueIdentifier>
     </Filter>
+    <Filter Include="System\Semver200">
+      <UniqueIdentifier>{60f9b310-81f7-4bf6-a829-c893dc59537a}</UniqueIdentifier>
+    </Filter>
     <Filter Include="GUI\Wrappers">
       <UniqueIdentifier>{14ff3fdb-4366-4bed-8b6e-ddcf72987b81}</UniqueIdentifier>
     </Filter>
@@ -567,6 +570,15 @@
     <ClInclude Include="Resources\Credits.h">
       <Filter>Resources</Filter>
     </ClInclude>
+    <ClInclude Include="System\Semver200\semver200.h">
+      <Filter>System\Semver200</Filter>
+    </ClInclude>
+    <ClInclude Include="System\Semver200\version.h">
+      <Filter>System\Semver200</Filter>
+    </ClInclude>
+    <ClInclude Include="System\GameVersion.h">
+      <Filter>System</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="System\Box.cpp">
@@ -1098,6 +1110,15 @@
     <ClCompile Include="Managers\WindowMan.cpp">
       <Filter>Managers</Filter>
     </ClCompile>
+    <ClCompile Include="System\Semver200\Semver200_comparator.cpp">
+      <Filter>System\Semver200</Filter>
+    </ClCompile>
+    <ClCompile Include="System\Semver200\Semver200_modifier.cpp">
+      <Filter>System\Semver200</Filter>
+    </ClCompile>
+    <ClCompile Include="System\Semver200\Semver200_parser.cpp">
+      <Filter>System\Semver200</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <Image Include="Resources\ccicon.ico">
@@ -1111,5 +1132,8 @@
   </ItemGroup>
   <ItemGroup>
     <None Include="cpp.hint" />
+    <None Include="System\Semver200\version.inl">
+      <Filter>System\Semver200</Filter>
+    </None>
   </ItemGroup>
 </Project>

System/Constants.h

@@ -9,11 +9,6 @@ namespace RTE {
 	typedef int MID; //!< Distinctive type definition for Material IDs.
 #pragma endregion
 
-#pragma region Game Version
-	static constexpr const char *c_MajorGameVersion = "Pre-Release 5";
-	static constexpr const char *c_MinorGameVersion = ".1";
-#pragma endregion
-
 #pragma region Userdata Constants
 	static const std::string c_UserScenesModuleName = "UserScenes.rte"; //!< Module name where user created Scenes are saved.
 	static const std::string c_UserScriptedSavesModuleName = "UserSavedGames.rte"; //!< Module name where user scripted Activity saves are saved.

System/DataModule.cpp

@@ -2,6 +2,9 @@
 #include "PresetMan.h"
 #include "SceneMan.h"
 #include "LuaMan.h"
+#include "GameVersion.h"
+
+#include <System/Semver200/semver200.h>
 
 namespace RTE {
 
@@ -15,7 +18,7 @@ namespace RTE {
 		m_FriendlyName.clear();
 		m_Author.clear();
 		m_Description.clear();
-		m_SupportedGameVersion.clear();
+		m_SupportedGameVersion = nullptr;
 		m_Version = 1;
 		m_ModuleID = -1;
 		m_IconFile.Reset();
@@ -49,18 +52,14 @@ namespace RTE {
 		// NOTE: This looks for the MergedIndex.ini generated by the index merger tool. The tool is mostly superseded by disabling loading visuals, but still provides some benefit.
 		if (std::filesystem::exists(mergedIndexPath)) { indexPath = mergedIndexPath; }
 
+		// If the module is a mod, read only its `index.ini` to validate its SupportedGameVersion.
+		if (m_ModuleID >= g_PresetMan.GetOfficialModuleCount() && !m_IsUserdata && ReadModuleProperties(moduleName, progressCallback) >= 0) {
+			CheckSupportedGameVersion();
+		}
+
 		if (reader.Create(indexPath, true, progressCallback) >= 0) {
 			int result = Serializable::Create(reader);
 
-			size_t lastPeriodPosition = m_SupportedGameVersion.find_last_of(".");
-			std::string supportedMajorGameVersion = m_SupportedGameVersion.substr(0, lastPeriodPosition);
-			std::string supportedMinorGameVersion = lastPeriodPosition == std::string::npos ? ".0" : m_SupportedGameVersion.substr(lastPeriodPosition, m_SupportedGameVersion.length());
-			if (m_ModuleID >= g_PresetMan.GetOfficialModuleCount() && !m_IsUserdata && (supportedMajorGameVersion != c_MajorGameVersion || supportedMinorGameVersion > c_MinorGameVersion)) {
-				RTEAssert(!m_SupportedGameVersion.empty(), m_FileName + " does not specify a supported Cortex Command version, so it is not compatible with this version of Cortex Command (" + c_MajorGameVersion + c_MinorGameVersion + ").\nPlease contact the mod author or ask for help in the CCCP discord server.");
-				RTEAssert(supportedMinorGameVersion <= c_MinorGameVersion, m_FileName + " supports Cortex Command version " + m_SupportedGameVersion + ", which is ahead of this version of Cortex Command (" + c_MajorGameVersion + c_MinorGameVersion + ").\nPlease update your game to the newest version to use this mod.");
-				RTEAbort(m_FileName + " supports Cortex Command version " + m_SupportedGameVersion + ", so it is not compatible with this version of Cortex Command (" + c_MajorGameVersion + c_MinorGameVersion + ").\nPlease contact the mod author or ask for help in the CCCP discord server.");
-			}
-
 			// Print an empty line to separate the end of a module from the beginning of the next one in the loading progress log.
 			if (progressCallback) { progressCallback(" ", true); }
 
@@ -95,6 +94,7 @@ namespace RTE {
 		for (const PresetEntry &preset : m_PresetList){
 			delete preset.m_EntityPreset;
 		}
+		delete m_SupportedGameVersion;
 		Clear();
 	}
 
@@ -145,7 +145,16 @@ namespace RTE {
 			reader >> m_IsMerchant;
 			if (m_IsMerchant) { m_IsFaction = false; }
 		} else if (propName == "SupportedGameVersion") {
-			reader >> m_SupportedGameVersion;
+			std::string versionText;
+			reader >> versionText;
+			// TODO: Need to proceed reading the includes after ReadModuleProperties so we don't read the properties again when fully creating.
+			if (!m_SupportedGameVersion) {
+				try {
+					m_SupportedGameVersion = new version::Semver200_version(versionText);
+				} catch (version::Parse_error &) {
+					reader.ReportError("Couldn't parse the supported game version from the value provided: \"" + versionText + "\"!\nThe supported game version must be a valid semantic version number.\n");
+				}
+			}
 		} else if (propName == "Version") {
 			reader >> m_Version;
 		} else if (propName == "ScanFolderContents") {
@@ -204,7 +213,7 @@ namespace RTE {
 			writer.NewPropertyWithValue("Author", m_Author);
 			writer.NewPropertyWithValue("Description", m_Description);
 			writer.NewPropertyWithValue("IsFaction", m_IsFaction);
-			writer.NewPropertyWithValue("SupportedGameVersion", m_SupportedGameVersion);
+			writer.NewPropertyWithValue("SupportedGameVersion", m_SupportedGameVersion->str());
 			writer.NewPropertyWithValue("Version", m_Version);
 			writer.NewPropertyWithValue("IconFile", m_IconFile);
 
@@ -481,4 +490,29 @@ namespace RTE {
 		}
 		return true;
 	}
+
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+	void DataModule::CheckSupportedGameVersion() const {
+		if (*m_SupportedGameVersion != c_GameVersion) {
+			static const std::string contactAuthor = "Please contact the mod author or ask for help in the CCCP discord server.";
+
+			RTEAssert(*m_SupportedGameVersion != version::Semver200_version(), m_FileName + " does not specify a supported Cortex Command version, so it is not compatible with this version of Cortex Command (" + c_GameVersion.str() + ").\n\n" + contactAuthor);
+
+			bool modulePrereleaseVersionMismatch = !m_SupportedGameVersion->prerelease().empty();
+			bool moduleBuildVersionMismatch = !m_SupportedGameVersion->build().empty();
+			RTEAssert(!modulePrereleaseVersionMismatch && !moduleBuildVersionMismatch, m_FileName + " was developed for pre-release build of Cortex Command v" + m_SupportedGameVersion->str() + ", this game version (v" + c_GameVersion.str() + ") is incompatible.\n\nMods developed on a pre-release must match the game version exactly.\n" + contactAuthor);
+
+			bool gamePrereleaseVersionMismatch = !c_GameVersion.prerelease().empty();
+			bool gameBuildVersionMismatch = !c_GameVersion.build().empty();
+			RTEAssert(!gamePrereleaseVersionMismatch && !gameBuildVersionMismatch, m_FileName + " was developed for Cortex Command v" + m_SupportedGameVersion->str() + ", this pre-release version of the game (v" + c_GameVersion.str() + ") may not support it.\n\nMods must match the game version exactly to use pre-release builds.\n" + contactAuthor);
+
+			// Game engine is the same major version as the Module
+			bool majorVersionMatch = c_GameVersion.major() == m_SupportedGameVersion->major();
+			// Game engine is at least the minor version the Module requires (allow patch mismatch)
+			bool minorVersionInRange = m_SupportedGameVersion->inc_minor() <= c_GameVersion.inc_minor();
+
+			RTEAssert(majorVersionMatch && minorVersionInRange, m_FileName + " was developed for Cortex Command v" + m_SupportedGameVersion->str() + ", so this version of Cortex Command (v" + c_GameVersion.str() + ") may not support it.\n" + contactAuthor);
+		}
+	}
 }

System/DataModule.h

@@ -7,6 +7,10 @@
 //struct DATAFILE; // DataFile loading not implemented.
 struct BITMAP;
 
+namespace version {
+	class Semver200_version;
+}
+
 namespace RTE {
 
 	class Entity;
@@ -320,7 +324,7 @@ namespace RTE {
 		std::string m_ScriptPath; //!< Path to script to execute when this module is loaded.
 		bool m_IsFaction; //!< Whether this data module is considered a faction.
 		bool m_IsMerchant; //!< Whether this data module is considered a merchant.
-		std::string m_SupportedGameVersion; //!< Game version this DataModule supports. Needs to match exactly for this DataModule to be allowed. Base DataModules don't need this.
+		version::Semver200_version *m_SupportedGameVersion; //!< Game version this DataModule supports. Needs to satisfy Caret Version Range for this DataModule to be allowed. Base DataModules don't need this.
 		int m_Version; //!< Version number, starting with 1.
 		int m_ModuleID; //!< ID number assigned to this upon loading, for internal use only, don't reflect in ini's.
 
@@ -355,6 +359,11 @@ namespace RTE {
 		static const std::string c_ClassName; //!< A string with the friendly-formatted type name of this object.
 
 #pragma region INI Handling
+		/// <summary>
+		/// Checks the module's supported game version against the current game version to ensure compatibility.
+		/// </summary>
+		void CheckSupportedGameVersion() const;
+
 		/// <summary>
 		/// If ScanFolderContents is enabled in this DataModule's Index.ini, looks for any ini files in the top-level directory of the module and reads all of them in alphabetical order.
 		/// </summary>

System/GameVersion.h

@@ -0,0 +1,13 @@
+#ifndef _RTEGAMEVERSION_
+#define _RTEGAMEVERSION_
+
+#include "System/Semver200/semver200.h"
+
+namespace RTE {
+
+#pragma region Game Version
+	static constexpr const char *c_VersionString = "5.1.0";
+	static const version::Semver200_version c_GameVersion = version::Semver200_version(c_VersionString);
+#pragma endregion
+}
+#endif

System/Reader.cpp

@@ -49,8 +49,8 @@ namespace RTE {
 
 		m_CanFail = failOK;
 
-		m_Stream = std::make_unique<std::ifstream>(fileName);
-		if (!m_CanFail) { RTEAssert(System::PathExistsCaseSensitive(fileName) && m_Stream->good(), "Failed to open data file \"" + m_FilePath + "\"!"); }
+		m_Stream = std::make_unique<std::ifstream>(m_FilePath);
+		if (!m_CanFail) { RTEAssert(System::PathExistsCaseSensitive(m_FilePath) && m_Stream->good(), "Failed to open data file \"" + m_FilePath + "\"!"); }
 
 		m_OverwriteExisting = overwrites;
 

System/Reader.h

@@ -91,7 +91,7 @@ namespace RTE {
 		/// <summary>
 		/// Set whether this reader should skip included files.
 		/// </summary>
-		/// <param name="skip>To make reader skip included files pass true, pass false otherwise.</param>
+		/// <param name="skip">To make reader skip included files pass true, pass false otherwise.</param>
 		void SetSkipIncludes(bool skip) { m_SkipIncludes = skip; };
 #pragma endregion