ValidateHandEvent()

bool ValidateHandEvent ( inout Serializer ctx, InventoryValidation validation )

protected

Pass partial information to guards so guards can do minimal checks if needed The guards can't prevent event so it would be incorrect to pass full InventoryValidation struct. We have to make sure guards don't inadvertantly produce different results in the FSM as that will create desync (two players attempting to put a rag into the same fireplace slot at the same time)

kumarjac: This indicates a failure in replication relationships as player full inventory should be synchronized always if player exists on the remote

TODO(kumarjac): Is this one correct to be 'RemoveMovableOverride' or are the other Validate methdos wrong with 'EnableMovableOverride'?

Do not check for action validity on remotes or when performing through juncture. Juncture locks guarentee the item is safe to interact with and the server has validated the command at this point. Checking at this point is both wasteful and can result in a failure which leads to desync

'HandEventBase.CheckRequestEx' updates failure reason

if it already happened on server, remote just needs to comply TODO(kumarjac): Move m_IsRemote check to inside of HandEventBase.CanPerformEventEx

'HandEventBase.CanPerformEventEx' updates failure reason

Check if this this is being executed on the server and not by a juncture or AI

Continuing on with execution of rest of the function

Is called twice unfortunately... but it works so won't change

TODO(kumarjac): We should probably set the result to failure like so

См. определение в файле DayZPlayerInventory.c строка 1519

    {
        InventoryCommandType type = InventoryCommandType.HAND_EVENT;
        bool success = true;
 
        HandEventBase e = HandEventBase.CreateHandEventFromContext(ctx);
 
        //client only
        e.ClearInventoryReservation();
        
        e.m_IsRemote = validation.m_IsRemote;
        e.m_IsJuncture = validation.m_IsJuncture;
 
        EntityAI itemSrc = e.GetSrcEntity();
        EntityAI itemDst = e.GetSecondSrcEntity();
 
        #ifdef ENABLE_LOGGING
        if (LogManager.IsInventoryMoveLogEnable())
        {
            Debug.InventoryMoveLog("STS = " + e.m_Player.GetSimulationTimeStamp() + " event= " + e.DumpToString(), "HAND_EVENT" , "n/a", "ProcessInputData", e.m_Player.ToString() );
        }
        #endif
 
        if (validation.m_IsJuncture && GetDayZPlayerOwner().GetInstanceType() == DayZPlayerInstanceType.INSTANCETYPE_SERVER && e.m_Player != GetManOwner())
        {
            Error("[syncinv] Inventory owner " + GetManOwner() + " and event sender " + e.m_Player + " do not match.");
            return true;
        }
 
        if (e.IsServerSideOnly())
        {
            Error("[syncinv] ValidateHandEvent This event " + e.GetDebugName() + " should not be use for synchronization.");
            return true;
        }
 
        if (validation.m_IsRemote && !itemSrc)
        {
            if (itemDst && (e.GetEventID() == HandEventID.SWAP || e.GetEventID() == HandEventID.FORCESWAP)) //presumed swap, replace with take
            {
                InventoryLocation srcNew = new InventoryLocation();
                srcNew.Copy(e.GetSrc());
                e = HandEventBase.HandEventFactory(HandEventID.TAKE, e.m_Player, srcNew);
                
                Error("[syncinv] HandleInputData remote swap event REPLACED with TAKE (cmd=HAND_EVENT, event=" + e.DumpToString() + "), src item is null! Continuing.");
            }
            else
            {
                #ifdef ENABLE_LOGGING
                if (LogManager.IsInventoryMoveLogEnable())
                {
                    Debug.InventoryMoveLog("Failed - CheckRequestSrc", "HAND_EVENT" , "n/a", "ProcessInputData", e.m_Player.ToString() );
                }
                #endif
                
                Error("[syncinv] HandleInputData remote input (cmd=HAND_EVENT, event=" + e.DumpToString() + ") dropped, item not in bubble");
                        
                return true;
            }
        }
        
        if (itemSrc)
            RemoveMovableOverride(itemSrc);
        if (itemDst)
            RemoveMovableOverride(itemDst);

        if (success && !validation.m_IsRemote && !validation.m_IsJuncture && !e.CheckRequestSrc())
        {
            #ifdef ENABLE_LOGGING
            if (LogManager.IsInventoryMoveLogEnable())
            {
                Debug.InventoryMoveLog("Failed - CheckRequestSrc", "HAND_EVENT" , "n/a", "ProcessInputData", e.m_Player.ToString() );
            }
            #endif
            
            if (!validation.m_IsRemote)
            {
                ctx = new ScriptInputUserData;
                InventoryInputUserData.SerializeHandEvent(ctx, e);
            }
 
            RemoveMovableOverride(itemSrc);
            RemoveMovableOverride(itemDst);
            
            if (GetDayZPlayerOwner().GetInstanceType() == DayZPlayerInstanceType.INSTANCETYPE_SERVER)
            {
                success = false;
                #ifdef DIAG_DEVELOPER
                if (PluginInventoryDebug.Cast(GetPlugin(PluginInventoryDebug)).IsDesyncRepairEnable())
                {
                #endif
                    array<EntityAI> itemsToRepair = new array<EntityAI>;
                    InventoryLocation repairIl = new InventoryLocation();
                    if(!itemSrc)
                    {
                        return false;
                    }
 
                    itemSrc.GetInventory().GetCurrentInventoryLocation(repairIl);
                    
                    if(e.GetSrc() != repairIl)
                    {
                        itemsToRepair.Insert(itemSrc);
                    }
    
                    if(itemDst && itemSrc != itemDst )
                    {
                        itemDst.GetInventory().GetCurrentInventoryLocation(repairIl);
                        if(e.GetSecondSrc() != repairIl)
                        {
                            itemsToRepair.Insert(itemDst);
                        }
                    }
    
                    if (itemsToRepair.Count())
                    {
                        InventoryInputUserData.SendServerInventoryCheck(itemsToRepair, GetDayZPlayerOwner());
                    }
                #ifdef DIAG_DEVELOPER
                }
                #endif
            }
            else
            {
                return true;
            }
        }
 
        if (success && !e.CheckRequestEx(validation))
        {
            #ifdef ENABLE_LOGGING
            if (LogManager.IsInventoryMoveLogEnable())
            {
                Debug.InventoryMoveLog("Failed - CheckRequest", "HAND_EVENT" , "n/a", "ProcessInputData", e.m_Player.ToString() );
            }
            #endif

 
            ctx = new ScriptInputUserData;
            InventoryInputUserData.SerializeHandEvent(ctx, e);
            
#ifdef ENABLE_LOGGING
            if (LogManager.IsSyncLogEnable())
            {
                syncDebugPrint("[cheat] HandleInputData man=" + Object.GetDebugName(GetManOwner()) + " STS = " + GetDayZPlayerOwner().GetSimulationTimeStamp() + " is cheating with cmd=" + typename.EnumToString(InventoryCommandType, type) + " event=" + e.DumpToString());
            }
#endif
            
            RemoveMovableOverride(itemSrc);
            RemoveMovableOverride(itemDst);
            
            if (GetDayZPlayerOwner().GetInstanceType() == DayZPlayerInstanceType.INSTANCETYPE_SERVER)
            {
                success = false;
            }
            else
            {
                return true;
            }
        }
        
        if (success && !validation.m_IsRemote && !e.CanPerformEventEx(validation))
        {
            #ifdef ENABLE_LOGGING
            if (LogManager.IsInventoryMoveLogEnable())
            {
                Debug.InventoryMoveLog("Failed - CanPerformEvent", "HAND_EVENT" , "n/a", "ProcessInputData", e.m_Player.ToString() );
            }
            #endif

 
            ctx = new ScriptInputUserData;
            InventoryInputUserData.SerializeHandEvent(ctx, e);
            
#ifdef ENABLE_LOGGING
            if (LogManager.IsSyncLogEnable())
            {
                syncDebugPrint("[desync] HandleInputData man=" + Object.GetDebugName(GetManOwner()) + " CANNOT do cmd=HAND_EVENT e=" + e.DumpToString());
            }
#endif
        
            RemoveMovableOverride(itemSrc);
            RemoveMovableOverride(itemDst);
            
            if (GetDayZPlayerOwner().GetInstanceType() == DayZPlayerInstanceType.INSTANCETYPE_SERVER)
            {
                InventoryLocation ilDst = e.GetDst();
                if (ilDst)
                    SendRepairToClientDst(ilDst);
 
                ilDst = e.GetSecondDst();
                if (ilDst)
                    SendRepairToClientDst(ilDst);
 
                success = false;
            }
            else
            {
                return true;
            }
        }
        
        RemoveMovableOverride(itemSrc);
        RemoveMovableOverride(itemDst);

        if (!validation.m_IsJuncture && GetDayZPlayerOwner().GetInstanceType() == DayZPlayerInstanceType.INSTANCETYPE_SERVER)
        {
            JunctureRequestResult result_ev = e.AcquireInventoryJunctureFromServer(GetDayZPlayerOwner());
            if (result_ev == JunctureRequestResult.JUNCTURE_NOT_REQUIRED)
            {
                #ifdef ENABLE_LOGGING
                if (LogManager.IsInventoryMoveLogEnable())
                {
                    Debug.InventoryMoveLog("Juncture not required", "HAND_EVENT" , "n/a", "ProcessInputData", e.m_Player.ToString() );
                }
                #endif

            }
            else if (success && result_ev == JunctureRequestResult.JUNCTURE_ACQUIRED)
            {
                #ifdef ENABLE_LOGGING
                if (LogManager.IsInventoryMoveLogEnable())
                {
                    Debug.InventoryMoveLog("Juncture sended", "HAND_EVENT" , "n/a", "ProcessInputData", e.m_Player.ToString() );
                }
                #endif
                
                ctx = new ScriptInputUserData;
                InventoryInputUserData.SerializeHandEvent(ctx, e);
            
                validation.m_Result = InventoryValidationResult.JUNCTURE;
                
                if (itemSrc)
                    EnableMovableOverride(itemSrc);
                if (itemDst)
                    EnableMovableOverride(itemDst);
                return true;
            }
            else
            {
                #ifdef ENABLE_LOGGING
                if (LogManager.IsInventoryMoveLogEnable())
                {
                    Debug.InventoryMoveLog("Juncture denied", "HAND_EVENT" , "n/a", "ProcessInputData", e.m_Player.ToString() );
                }
                #endif
 
                validation.m_Result = InventoryValidationResult.FAILED;
                validation.m_Reason = InventoryValidationReason.JUNCTURE_DENIED;
                return true;
            }
        }
        // Check whether the juncture for the related player and items has been acquired.
        else if (validation.m_IsJuncture && GetDayZPlayerOwner().GetInstanceType() == DayZPlayerInstanceType.INSTANCETYPE_SERVER)        
        {
            bool hasJuncture = false;
            
            if (itemSrc != null && itemDst != null)
            {
                hasJuncture = g_Game.HasInventoryJuncture(GetDayZPlayerOwner(), itemSrc) && g_Game.HasInventoryJuncture(GetDayZPlayerOwner(), itemDst);
            }
            else if (itemSrc != null)
            {
                hasJuncture = g_Game.HasInventoryJuncture(GetDayZPlayerOwner(), itemSrc);
            }
            else if (itemDst != null)
            {
                hasJuncture = g_Game.HasInventoryJuncture(GetDayZPlayerOwner(), itemDst);       
            }
 
            if (!hasJuncture) 
            {
#ifdef ENABLE_LOGGING
            if (LogManager.IsInventoryMoveLogEnable())
            {
                Debug.InventoryMoveLog("Failed - missing juncture", "HAND_EVENT", "n/a", "ProcessInputData", GetDayZPlayerOwner().ToString() );
            }
#endif
                success = false;
            }       
        }

        if (success && GetDayZPlayerOwner().GetInstanceType() == DayZPlayerInstanceType.INSTANCETYPE_SERVER)
        {
            CheckForRope(e.GetSrc(), e.GetDst());
        }
 
        #ifdef ENABLE_LOGGING
        if (LogManager.IsInventoryMoveLogEnable())
        {
            Debug.InventoryMoveLog("Success - ProcessHandEvent", "HAND_EVENT" , "n/a", "ProcessInputData", e.m_Player.ToString() );
        }
        #endif
        
        if (success)
        {
            validation.m_Result = InventoryValidationResult.SUCCESS;
            if (!e.m_Player.GetHumanInventory().ProcessHandEvent(e))
            {
                //result = InventoryValidationResult.FAILURE;
            }
        }
 
        return true;
    }

Перекрестные ссылки HandEventBase::AcquireInventoryJunctureFromServer(), HandEventBase::CanPerformEventEx(), CheckForRope(), HandEventBase::CheckRequestSrc(), HandEventBase::ClearInventoryReservation(), InventoryLocation::Copy(), HandEventBase::DumpToString(), EnableMovableOverride(), Error(), g_Game, GetDayZPlayerOwner(), HandEventBase::GetDst(), GetInstanceType(), GetPlugin(), HandEventBase::GetSecondDst(), HandEventBase::GetSecondSrc(), HandEventBase::GetSecondSrcEntity(), Debug::InventoryMoveLog(), LogManager::IsInventoryMoveLogEnable(), HandEventBase::IsServerSideOnly(), LogManager::IsSyncLogEnable(), InventoryValidation::m_IsJuncture, InventoryValidation::m_IsRemote, InventoryValidation::m_Reason, InventoryValidation::m_Result, RemoveMovableOverride(), SendRepairToClientDst(), InventoryInputUserData::SendServerInventoryCheck(), InventoryInputUserData::SerializeHandEvent(), syncDebugPrint() и ToString().

Используется в ProcessInputData().