Fix #741: Add new CServerRPCControlPacket to toggle RPCs from server (#1978)

* Move server RPC function enums to Shared

* Add new CServerRPCGatePacket and use it to share rpc function state

* Move IsServerRPCFunctionEnabled check into CNetAPI::RPC

* Rename CServerRPCGatePacket to CServerRPCControlPacket

* Remove bitstream bump and check

* Remove unused GetAllHandles function

* Some small nit cleanup

* Use std::array instead

* Move duplicate broadcast code under a shared private function

* Merge assignment into if statement

* Rename Toggle to Disable for clarity

* Move SEvent* out from the for loop

Author: patrikjuvonen

Client/mods/deathmatch/StdInc.h

@@ -47,6 +47,7 @@
 #include <ijsify.h>
 #include <Common.h>
 #include "net/Packets.h"
+#include "net/rpc_enums.h"
 #include "Enums.h"
 #include "net/SyncStructures.h"
 #include "CIdArray.h"

Client/mods/deathmatch/logic/CClientGame.h

@@ -440,6 +440,12 @@ class CClientGame
 
     void TriggerDiscordJoin(SString strSecret);
 
+    inline const bool IsServerRPCFunctionDisabled(const eServerRPCFunctions eServerRPCFunction) const { return m_disabledServerRPCFunctions[eServerRPCFunction]; };
+    inline void SetServerRPCFunctionDisabled(const eServerRPCFunctions eServerRPCFunction, const bool bDisabled = true)
+    {
+        m_disabledServerRPCFunctions[eServerRPCFunction] = bDisabled;
+    };
+
 private:
     // CGUI Callbacks
     bool OnKeyDown(CGUIKeyEventArgs Args);
@@ -824,6 +830,8 @@ class CClientGame
     SString                 m_strACInfo;
     std::map<uint, uint>    m_SentMessageIds;
 
+    std::array<bool, eServerRPCFunctions::NUM_SERVER_RPC_FUNCS> m_disabledServerRPCFunctions;
+
     bool              m_bLastKeyWasEscapeCancelled;
     std::set<SString> m_AllowKeyUpMap;
     uint              m_uiPrecisionCallDepth;

Client/mods/deathmatch/logic/CNetAPI.cpp

@@ -1993,6 +1993,9 @@ void CNetAPI::WriteCameraSync(NetBitStreamInterface& BitStream)
 
 void CNetAPI::RPC(eServerRPCFunctions ID, NetBitStreamInterface* pBitStream)
 {
+    if (g_pClientGame->IsServerRPCFunctionDisabled(ID))
+        return;
+
     NetBitStreamInterface* pRPCBitStream = g_pNet->AllocateNetBitStream();
     if (pRPCBitStream)
     {

Client/mods/deathmatch/logic/CNetAPI.h

@@ -25,17 +25,6 @@ class CNetAPI;
 #define CAM_SYNC_RATE   ( g_TickRateSettings.iCamSync )
 #define TICK_RATE_AIM   ( std::min ( TICK_RATE, g_TickRateSettings.iKeySyncRotation ) )  // Keysync or puresync update the aim, so use the shortest interval
 
-enum eServerRPCFunctions
-{
-    PLAYER_INGAME_NOTICE,
-    INITIAL_DATA_STREAM,
-    PLAYER_TARGET,
-    PLAYER_WEAPON,
-    KEY_BIND,
-    CURSOR_EVENT,
-    REQUEST_STEALTH_KILL,
-};
-
 class CNetAPI
 {
 public:

Client/mods/deathmatch/logic/CPacketHandler.cpp

@@ -210,6 +210,10 @@ bool CPacketHandler::ProcessPacket(unsigned char ucPacketID, NetBitStreamInterfa
             Packet_ServerInfoSync(bitStream);
             return true;
 
+        case PACKET_ID_SERVER_RPC_CONTROL:
+            Packet_ServerRPCControl(bitStream);
+            return true;
+
         default:
             break;
     }
@@ -5320,6 +5324,21 @@ void CPacketHandler::Packet_ServerInfoSync(NetBitStreamInterface& bitStream)
     }
 }
 
+void CPacketHandler::Packet_ServerRPCControl(NetBitStreamInterface& bitStream)
+{
+    unsigned short usNumFunctions;
+    if (bitStream.ReadCompressed(usNumFunctions))
+    {
+        for (unsigned short us = 0; us < usNumFunctions; us++)
+        {
+            unsigned int uiServerRPCFunction;
+            bool         bDisabled;
+            if (bitStream.Read(uiServerRPCFunction) && bitStream.ReadBit(bDisabled))
+                g_pClientGame->SetServerRPCFunctionDisabled(static_cast<eServerRPCFunctions>(uiServerRPCFunction), bDisabled);
+        }
+    }
+}
+
 //
 //
 //

Client/mods/deathmatch/logic/CPacketHandler.h

@@ -100,6 +100,7 @@ class CPacketHandler
     void Packet_ChatClear(NetBitStreamInterface& bitStream);
     void Packet_ServerInfoSync(NetBitStreamInterface& bitStream);
     void Packet_PolygonHeight(NetBitStreamInterface& bitStream);
+    void Packet_ServerRPCControl(NetBitStreamInterface& bitStream);
 
     // For debugging protocol errors during ENTITY_ADD packet
     void    EntityAddDebugBegin(uint uiNumEntities, NetBitStreamInterface* pBitStream);

Client/mods/deathmatch/logic/rpc/CRPCFunctions.cpp

@@ -49,8 +49,8 @@ CBlendedWeather*           CRPCFunctions::m_pBlendedWeather;
 CClientGame*               CRPCFunctions::m_pClientGame;
 CClientWaterManager*       CRPCFunctions::m_pWaterManager;
 
-SFixedArray<CRPCFunctions::SRPCHandler, CRPCFunctions::NUM_RPC_FUNCS>        CRPCFunctions::m_RPCHandlers;
-SFixedArray<CRPCFunctions::SElementRPCHandler, CRPCFunctions::NUM_RPC_FUNCS> CRPCFunctions::m_ElementRPCHandlers;
+SFixedArray<CRPCFunctions::SRPCHandler, eElementRPCFunctions::NUM_RPC_FUNCS>        CRPCFunctions::m_RPCHandlers;
+SFixedArray<CRPCFunctions::SElementRPCHandler, eElementRPCFunctions::NUM_RPC_FUNCS> CRPCFunctions::m_ElementRPCHandlers;
 
 CRPCFunctions::CRPCFunctions(CClientGame* pClientGame)
 {

Server/mods/deathmatch/StdInc.h

@@ -40,6 +40,7 @@ struct SAclRequest;
 #include "CBox.h"
 #include "CMatrix.h"
 #include "net/Packets.h"
+#include "net/rpc_enums.h"
 #include "Enums.h"
 #include <bochs_internal/bochs_crc32.h>
 #include "CChecksum.h"
@@ -95,6 +96,7 @@ struct SAclRequest;
 #include "packets/CResourceStopPacket.h"
 #include "packets/CResourceClientScriptsPacket.h"
 #include "packets/CReturnSyncPacket.h"
+#include "packets/CServerRPCControlPacket.h"
 #include "packets/CServerTextItemPacket.h"
 #include "packets/CUpdateInfoPacket.h"
 #include "packets/CUnoccupiedVehicleStartSyncPacket.h"

Server/mods/deathmatch/logic/CEvents.cpp

@@ -17,7 +17,7 @@ CEvents::CEvents()
     m_bEventCancelled = false;
 }
 
-bool CEvents::AddEvent(const char* szName, const char* szArguments, CLuaMain* pLuaMain, bool bAllowRemoteTrigger)
+bool CEvents::AddEvent(const char* szName, const char* szArguments, CLuaMain* pLuaMain, bool bAllowRemoteTrigger, eServerRPCFunctions eServerRPCFunction)
 {
     assert(szName);
     assert(szArguments);
@@ -32,6 +32,7 @@ bool CEvents::AddEvent(const char* szName, const char* szArguments, CLuaMain* pL
     pEvent->strArguments = szArguments;
     pEvent->pLuaMain = pLuaMain;
     pEvent->bAllowRemoteTrigger = bAllowRemoteTrigger;
+    pEvent->eServerRPCFunction = eServerRPCFunction;
 
     m_EventHashMap[szName] = pEvent;
 

Server/mods/deathmatch/logic/CEvents.h

@@ -17,10 +17,11 @@
 
 struct SEvent
 {
-    class CLuaMain* pLuaMain;
-    std::string     strName;
-    std::string     strArguments;
-    bool            bAllowRemoteTrigger;
+    class CLuaMain*     pLuaMain;
+    std::string         strName;
+    std::string         strArguments;
+    bool                bAllowRemoteTrigger;
+    eServerRPCFunctions eServerRPCFunction;
 };
 
 class CEvents
@@ -29,7 +30,8 @@ class CEvents
     CEvents();
     ~CEvents() { RemoveAllEvents(); };
 
-    bool AddEvent(const char* szName, const char* szArguments, class CLuaMain* pLuaMain, bool bAllowRemoteTrigger);
+    bool AddEvent(const char* szName, const char* szArguments, class CLuaMain* pLuaMain, bool bAllowRemoteTrigger,
+                  eServerRPCFunctions eServerRPCFunction = eServerRPCFunctions::NUM_SERVER_RPC_FUNCS);
     void RemoveEvent(SEvent* pEvent);
     void RemoveEvent(const char* szName);
     void RemoveAllEvents(class CLuaMain* pMain);