Add map migrations system for automatic CS2 update breakage fixup

Author: Vauff

AMBuilder

@@ -72,6 +72,7 @@ for sdk_target in MMSPlugin.sdk_targets:
     'src/buttonwatch.cpp',
     'src/topdefender.cpp',
     'src/idlemanager.cpp',
+    'src/mapmigrations.cpp',
     'sdk/entity2/entitysystem.cpp',
     'sdk/entity2/entityidentity.cpp',
     'sdk/entity2/entitykeyvalues.cpp',

CS2Fixes.vcxproj

@@ -213,6 +213,7 @@
     <ClCompile Include="src\zombiereborn.cpp" />
     <ClCompile Include="src\entitylistener.cpp" />
     <ClCompile Include="src\leader.cpp" />
+    <ClCompile Include="src\mapmigrations.cpp" />
     <ClCompile Include="sdk\tier1\convar.cpp" />
     <ClCompile Include="src\utils\entity.cpp" />
     <ClCompile Include="src\utils\plat_unix.cpp" />
@@ -291,6 +292,7 @@
     <ClInclude Include="src\zombiereborn.h" />
     <ClInclude Include="src\entitylistener.h" />
     <ClInclude Include="src\leader.h" />
+    <ClCompile Include="src\mapmigrations.h" />
     <ClInclude Include="src\utils\entity.h" />
     <ClInclude Include="src\utils\module.h" />
     <ClInclude Include="src\utils\plat.h" />

CS2Fixes.vcxproj.filters

@@ -200,6 +200,9 @@
     <ClCompile Include="src\topdefender.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="src\mapmigrations.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="src\mempatch.h">
@@ -427,5 +430,8 @@
     <ClInclude Include="src\topdefender.h">
       <Filter>Header Files</Filter>
     </ClInclude>
+    <ClInclude Include="src\mapmigrations.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
   </ItemGroup>
 </Project>

cfg/cs2fixes/cs2fixes.cfg

@@ -162,4 +162,7 @@ entwatch_glow_team				0		// Whether dropped item glow is only visible to the tea
 // Hud settings
 cs2f_fix_hud_flashing			0		// Whether to fix hud flashing using a workaround, this BREAKS warmup so pick one or the other
 cs2f_disable_hud_outside_round	0		// Whether to disable hud messages that would flash when a round is not ongoing, since flashing fix cannot run then
-cs2f_hud_duration_leeway		2		// Extra seconds duration to leave hud messages visible (without priority), reduces transition flashes between different priority messages
+cs2f_hud_duration_leeway		2		// Extra seconds duration to leave hud messages visible (without priority), reduces transition flashes between different priority messages
+
+// Map migrations
+cs2f_mapmigrations_20260121		2		// Current mode for 2026-01-21 CS2 update map migrations. [0 = Force disabled, 1 = Force enabled, 2 = Automatically enabled for maps updated before 2026-01-21 & disabled if updated after]

src/cs2fixes.cpp

@@ -45,6 +45,7 @@
 #include "interface.h"
 #include "leader.h"
 #include "map_votes.h"
+#include "mapmigrations.h"
 #include "networkstringtabledefs.h"
 #include "panoramavote.h"
 #include "patches.h"
@@ -356,6 +357,7 @@ bool CS2Fixes::Load(PluginId id, ISmmAPI* ismm, char* error, size_t maxlen, bool
 	g_pIdleSystem = new CIdleSystem();
 	g_pPanoramaVoteHandler = new CPanoramaVoteHandler();
 	g_pEWHandler = new CEWHandler();
+	g_pMapMigrations = new CMapMigrations();
 
 	RegisterWeaponCommands();
 
@@ -506,6 +508,9 @@ bool CS2Fixes::Unload(char* error, size_t maxlen)
 		delete g_pEWHandler;
 	}
 
+	if (g_pMapMigrations)
+		delete g_pMapMigrations;
+
 	return true;
 }
 
@@ -1036,6 +1041,7 @@ void CS2Fixes::Hook_CheckTransmit(CCheckTransmitInfo** ppInfoList, int infoCount
 void CS2Fixes::Hook_ApplyGameSettings(KeyValues* pKV)
 {
 	g_pMapVoteSystem->ApplyGameSettings(pKV);
+	g_pMapMigrations->ApplyGameSettings(pKV);
 }
 
 void CS2Fixes::Hook_CreateWorkshopMapGroup(const char* name, const CUtlStringList& mapList)

src/entitylistener.cpp

@@ -25,6 +25,7 @@
 #include "entity/cgamerules.h"
 #include "entwatch.h"
 #include "gameconfig.h"
+#include "mapmigrations.h"
 #include "plat.h"
 
 CEntityListener* g_pEntityListener = nullptr;
@@ -55,6 +56,8 @@ void CEntityListener::OnEntitySpawned(CEntityInstance* pEntity)
 
 	if (g_cvarEnableEntWatch.Get())
 		EW_OnEntitySpawned(pEntity);
+
+	g_pMapMigrations->OnEntitySpawned(pEntity);
 }
 
 void CEntityListener::OnEntityCreated(CEntityInstance* pEntity)

src/map_votes.cpp

@@ -661,7 +661,7 @@ void CMapVoteSystem::HandlePlayerMapLookup(CCSPlayerController* pController, std
 		// Check if input is numeric (workshop ID)
 		if (iWorkshopId != 0)
 		{
-			CWorkshopDetailsQuery::Create(iWorkshopId, pController, callbackSuccess);
+			CMapSystemWorkshopDetailsQuery::Create(iWorkshopId, pController, callbackSuccess);
 			return;
 		}
 
@@ -1386,7 +1386,7 @@ std::pair<int, std::shared_ptr<CMap>> CMapVoteSystem::GetMapInfoByIdentifiers(co
 	return {-1, nullptr};
 }
 
-std::shared_ptr<CWorkshopDetailsQuery> CWorkshopDetailsQuery::Create(uint64 iWorkshopId, CCSPlayerController* pController, QueryCallback_t callbackSuccess)
+std::shared_ptr<CMapSystemWorkshopDetailsQuery> CMapSystemWorkshopDetailsQuery::Create(uint64 iWorkshopId, CCSPlayerController* pController, QueryCallback_t callbackSuccess)
 {
 	uint64 iWorkshopIDArray[1] = {iWorkshopId};
 	UGCQueryHandle_t hQuery = g_steamAPI.SteamUGC()->CreateQueryUGCDetailsRequest(iWorkshopIDArray, 1);
@@ -1400,14 +1400,14 @@ std::shared_ptr<CWorkshopDetailsQuery> CWorkshopDetailsQuery::Create(uint64 iWor
 	g_steamAPI.SteamUGC()->SetAllowCachedResponse(hQuery, 0);
 	SteamAPICall_t hCall = g_steamAPI.SteamUGC()->SendQueryUGCRequest(hQuery);
 
-	auto pQuery = std::make_shared<CWorkshopDetailsQuery>(hQuery, iWorkshopId, pController, callbackSuccess);
+	auto pQuery = std::make_shared<CMapSystemWorkshopDetailsQuery>(hQuery, iWorkshopId, pController, callbackSuccess);
 	g_pMapVoteSystem->AddWorkshopDetailsQuery(pQuery);
-	pQuery->m_CallResult.Set(hCall, pQuery.get(), &CWorkshopDetailsQuery::OnQueryCompleted);
+	pQuery->m_CallResult.Set(hCall, pQuery.get(), &CMapSystemWorkshopDetailsQuery::OnQueryCompleted);
 
 	return pQuery;
 }
 
-void CWorkshopDetailsQuery::OnQueryCompleted(SteamUGCQueryCompleted_t* pCompletedQuery, bool bFailed)
+void CMapSystemWorkshopDetailsQuery::OnQueryCompleted(SteamUGCQueryCompleted_t* pCompletedQuery, bool bFailed)
 {
 	CCSPlayerController* pController = m_hController.Get();
 	SteamUGCDetails_t details;

src/map_votes.h

@@ -132,10 +132,10 @@ class CGroup
 };
 
 // Implementation is a bit hardcoded for HandlePlayerMapLookup use
-class CWorkshopDetailsQuery : public std::enable_shared_from_this<CWorkshopDetailsQuery>
+class CMapSystemWorkshopDetailsQuery : public std::enable_shared_from_this<CMapSystemWorkshopDetailsQuery>
 {
 public:
-	CWorkshopDetailsQuery(UGCQueryHandle_t hQuery, uint64 iWorkshopId, CCSPlayerController* pController, QueryCallback_t callbackSuccess) :
+	CMapSystemWorkshopDetailsQuery(UGCQueryHandle_t hQuery, uint64 iWorkshopId, CCSPlayerController* pController, QueryCallback_t callbackSuccess) :
 		m_hQuery(hQuery), m_iWorkshopId(iWorkshopId), m_callbackSuccess(callbackSuccess)
 	{
 		if (pController)
@@ -149,13 +149,13 @@ class CWorkshopDetailsQuery : public std::enable_shared_from_this<CWorkshopDetai
 		}
 	}
 
-	static std::shared_ptr<CWorkshopDetailsQuery> Create(uint64 iWorkshopId, CCSPlayerController* pController, QueryCallback_t callbackSuccess);
+	static std::shared_ptr<CMapSystemWorkshopDetailsQuery> Create(uint64 iWorkshopId, CCSPlayerController* pController, QueryCallback_t callbackSuccess);
 
 private:
 	void OnQueryCompleted(SteamUGCQueryCompleted_t* pCompletedQuery, bool bFailed);
 
 	UGCQueryHandle_t m_hQuery;
-	CCallResult<CWorkshopDetailsQuery, SteamUGCQueryCompleted_t> m_CallResult;
+	CCallResult<CMapSystemWorkshopDetailsQuery, SteamUGCQueryCompleted_t> m_CallResult;
 	uint64 m_iWorkshopId;
 	bool m_bConsole;
 	CHandle<CCSPlayerController> m_hController;
@@ -218,8 +218,8 @@ class CMapVoteSystem
 	void ProcessGroupCooldowns();
 	bool ReloadMapList(bool bReloadMap = true);
 	bool ConvertCooldownsKVToJSON();
-	void AddWorkshopDetailsQuery(std::shared_ptr<CWorkshopDetailsQuery> pQuery) { m_vecWorkshopDetailsQueries.push_back(pQuery); }
-	void RemoveWorkshopDetailsQuery(std::shared_ptr<CWorkshopDetailsQuery> pQuery) { m_vecWorkshopDetailsQueries.erase(std::remove(m_vecWorkshopDetailsQueries.begin(), m_vecWorkshopDetailsQueries.end(), pQuery), m_vecWorkshopDetailsQueries.end()); }
+	void AddWorkshopDetailsQuery(std::shared_ptr<CMapSystemWorkshopDetailsQuery> pQuery) { m_vecWorkshopDetailsQueries.push_back(pQuery); }
+	void RemoveWorkshopDetailsQuery(std::shared_ptr<CMapSystemWorkshopDetailsQuery> pQuery) { m_vecWorkshopDetailsQueries.erase(std::remove(m_vecWorkshopDetailsQueries.begin(), m_vecWorkshopDetailsQueries.end(), pQuery), m_vecWorkshopDetailsQueries.end()); }
 	void SetPlayerNomination(int iPlayerSlot, int iMapIndex) { m_arrPlayerNominations[iPlayerSlot] = iMapIndex; }
 
 private:
@@ -247,7 +247,7 @@ class CMapVoteSystem
 	std::filesystem::file_time_type m_timeMapListModified = std::filesystem::file_time_type::min();
 	std::weak_ptr<CTimer> m_pDownloadProgressTimer;
 	std::weak_ptr<CTimer> m_pRateLimitedDownloadTimer;
-	std::vector<std::shared_ptr<CWorkshopDetailsQuery>> m_vecWorkshopDetailsQueries;
+	std::vector<std::shared_ptr<CMapSystemWorkshopDetailsQuery>> m_vecWorkshopDetailsQueries;
 };
 
 extern CMapVoteSystem* g_pMapVoteSystem;

src/mapmigrations.cpp

@@ -0,0 +1,123 @@
+/**
+ * =============================================================================
+ * CS2Fixes
+ * Copyright (C) 2023-2025 Source2ZE
+ * =============================================================================
+ *
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, version 3.0, as published by the
+ * Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "mapmigrations.h"
+#include "cs2fixes.h"
+#include "entity.h"
+#include "entity/cbasemodelentity.h"
+#include "utils.h"
+
+CMapMigrations* g_pMapMigrations = nullptr;
+
+const time_t g_time20260121 = 1769036239;
+
+CConVar<int> g_cvarMapMigrations20260121("cs2f_mapmigrations_20260121", FCVAR_NONE, "Current mode for 2026-01-21 CS2 update map migrations. [0 = Force disabled, 1 = Force enabled, 2 = Automatically enabled for maps updated before 2026-01-21 & disabled if updated after]", 2);
+
+void CMapMigrations::ApplyGameSettings(KeyValues* pKV)
+{
+	m_timeMapUpdated = std::numeric_limits<time_t>::max();
+
+	// Don't run on default maps
+	if (!pKV->FindKey("launchoptions") || !pKV->FindKey("launchoptions")->FindKey("customgamemode"))
+		return;
+
+	CMapMigrationWorkshopDetailsQuery::Create(pKV->FindKey("launchoptions")->GetUint64("customgamemode"));
+}
+
+void CMapMigrations::OnEntitySpawned(CEntityInstance* pEntity)
+{
+	if (g_cvarMapMigrations20260121.Get() == 1 || (g_cvarMapMigrations20260121.Get() == 2 && m_timeMapUpdated < g_time20260121))
+		Migration_20260121(pEntity);
+}
+
+void CMapMigrations::Migration_20260121(CEntityInstance* pEntity)
+{
+	CBaseEntity* pBaseEntity = (CBaseEntity*)pEntity;
+
+	if (!V_strcasecmp(pEntity->GetClassname(), "func_door_rotating"))
+	{
+		uint32 spawnFlags = pBaseEntity->m_spawnflags();
+
+		// Force add One-way flag if not present
+		if (!(spawnFlags & 16))
+			pBaseEntity->m_spawnflags = spawnFlags + 16;
+	}
+
+	CBaseModelEntity* pModelEntity = pBaseEntity->AsBaseModelEntity();
+
+	if (pModelEntity)
+	{
+		RenderMode_t renderMode = pModelEntity->m_nRenderMode();
+
+		// Legacy kRenderTransAlpha
+		if (renderMode == 4)
+			pModelEntity->m_nRenderMode = kRenderTransAlpha;
+		// Legacy kRenderNone
+		else if (renderMode == 10)
+			pModelEntity->m_nRenderMode = kRenderNone;
+		// All other removed render modes, fall back to normal
+		else if (renderMode > kRenderNormal)
+			pModelEntity->m_nRenderMode = kRenderNormal;
+	}
+}
+
+void CMapMigrations::UpdateMapUpdateTime(time_t timeMapUpdated)
+{
+	m_timeMapUpdated = timeMapUpdated;
+
+	CBaseEntity* pTarget = nullptr;
+
+	// May be called late, so also check any existing entities first
+	while ((pTarget = UTIL_FindEntityByName(pTarget, "*")))
+		OnEntitySpawned(pTarget);
+}
+
+std::shared_ptr<CMapMigrationWorkshopDetailsQuery> CMapMigrationWorkshopDetailsQuery::Create(uint64 iWorkshopId)
+{
+	uint64 iWorkshopIDArray[1] = {iWorkshopId};
+	UGCQueryHandle_t hQuery = g_steamAPI.SteamUGC()->CreateQueryUGCDetailsRequest(iWorkshopIDArray, 1);
+
+	if (hQuery == k_UGCQueryHandleInvalid)
+	{
+		Panic("Map migrations failed to find current map update time: failed to query workshop map information for ID %llu\n", iWorkshopId);
+		return nullptr;
+	}
+
+	g_steamAPI.SteamUGC()->SetAllowCachedResponse(hQuery, 0);
+	SteamAPICall_t hCall = g_steamAPI.SteamUGC()->SendQueryUGCRequest(hQuery);
+
+	auto pQuery = std::make_shared<CMapMigrationWorkshopDetailsQuery>(hQuery, iWorkshopId);
+	g_pMapMigrations->AddWorkshopDetailsQuery(pQuery);
+	pQuery->m_CallResult.Set(hCall, pQuery.get(), &CMapMigrationWorkshopDetailsQuery::OnQueryCompleted);
+
+	return pQuery;
+}
+
+void CMapMigrationWorkshopDetailsQuery::OnQueryCompleted(SteamUGCQueryCompleted_t* pCompletedQuery, bool bFailed)
+{
+	SteamUGCDetails_t details;
+
+	if (bFailed || pCompletedQuery->m_eResult != k_EResultOK || pCompletedQuery->m_unNumResultsReturned < 1 || !g_steamAPI.SteamUGC()->GetQueryUGCResult(pCompletedQuery->m_handle, 0, &details) || details.m_eResult != k_EResultOK)
+		Panic("Map migrations failed to find current map update time: failed to query workshop map information for ID %llu\n", m_iWorkshopId);
+	else
+		g_pMapMigrations->UpdateMapUpdateTime(details.m_rtimeUpdated);
+
+	g_steamAPI.SteamUGC()->ReleaseQueryUGCRequest(m_hQuery);
+	g_pMapMigrations->RemoveWorkshopDetailsQuery(shared_from_this());
+}

src/mapmigrations.h

@@ -0,0 +1,62 @@
+/**
+ * =============================================================================
+ * CS2Fixes
+ * Copyright (C) 2023-2025 Source2ZE
+ * =============================================================================
+ *
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, version 3.0, as published by the
+ * Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#include "KeyValues.h"
+#include "convar.h"
+#include "entitysystem.h"
+#include "steam/isteamugc.h"
+#include <vector>
+
+extern CConVar<int> g_cvarMapMigrations20260121;
+
+class CMapMigrationWorkshopDetailsQuery : public std::enable_shared_from_this<CMapMigrationWorkshopDetailsQuery>
+{
+public:
+	CMapMigrationWorkshopDetailsQuery(UGCQueryHandle_t hQuery, uint64 iWorkshopId) :
+		m_hQuery(hQuery), m_iWorkshopId(iWorkshopId)
+	{}
+
+	static std::shared_ptr<CMapMigrationWorkshopDetailsQuery> Create(uint64 iWorkshopId);
+
+private:
+	void OnQueryCompleted(SteamUGCQueryCompleted_t* pCompletedQuery, bool bFailed);
+
+	UGCQueryHandle_t m_hQuery;
+	CCallResult<CMapMigrationWorkshopDetailsQuery, SteamUGCQueryCompleted_t> m_CallResult;
+	uint64 m_iWorkshopId;
+};
+
+class CMapMigrations
+{
+public:
+	void ApplyGameSettings(KeyValues* pKV);
+	void OnEntitySpawned(CEntityInstance* pEntity);
+	void Migration_20260121(CEntityInstance* pEntity);
+	void UpdateMapUpdateTime(time_t timeMapUpdated);
+	void AddWorkshopDetailsQuery(std::shared_ptr<CMapMigrationWorkshopDetailsQuery> pQuery) { m_vecWorkshopDetailsQueries.push_back(pQuery); }
+	void RemoveWorkshopDetailsQuery(std::shared_ptr<CMapMigrationWorkshopDetailsQuery> pQuery) { m_vecWorkshopDetailsQueries.erase(std::remove(m_vecWorkshopDetailsQueries.begin(), m_vecWorkshopDetailsQueries.end(), pQuery), m_vecWorkshopDetailsQueries.end()); }
+
+private:
+	time_t m_timeMapUpdated = std::numeric_limits<time_t>::max();
+	std::vector<std::shared_ptr<CMapMigrationWorkshopDetailsQuery>> m_vecWorkshopDetailsQueries;
+};
+
+extern CMapMigrations* g_pMapMigrations;