Synchronize changes from 1.6 master branch [ci skip]

7ebcf59 Simplify ACL request refresh detection (improves #4409) (#4483)
8d41e19 Resolve Event Context Loss in Nested Event Cacnellation (#4529)

Author: github-actions[bot]

Server/mods/deathmatch/logic/CElement.cpp

@@ -438,10 +438,11 @@ bool CElement::CallEvent(const char* szName, const CLuaArguments& Arguments, CPl
     if (!g_pGame->GetDebugHookManager()->OnPreEvent(szName, Arguments, this, pCaller))
         return false;
 
-    CEvents* pEvents = g_pGame->GetEvents();
+    CEvents*      pEvents = g_pGame->GetEvents();
+    CEventContext eventContext;
 
     // Make sure our event-manager knows we're about to call an event
-    pEvents->PreEventPulse();
+    pEvents->PreEventPulse(&eventContext);
 
     // Call the event on our parents/us first
     CallParentEvent(szName, Arguments, this, pCaller);
@@ -450,12 +451,12 @@ bool CElement::CallEvent(const char* szName, const CLuaArguments& Arguments, CPl
     CallEventNoParent(szName, Arguments, this, pCaller);
 
     // Tell the event manager that we're done calling the event
-    pEvents->PostEventPulse();
+    pEvents->PostEventPulse(&eventContext);
 
     g_pGame->GetDebugHookManager()->OnPostEvent(szName, Arguments, this, pCaller);
 
     // Return whether our event was cancelled or not
-    return (!pEvents->WasEventCancelled());
+    return !eventContext.IsCancelled();
 }
 
 bool CElement::DeleteEvent(CLuaMain* pLuaMain, const char* szName, const CLuaFunctionRef& iLuaFunction)

Server/mods/deathmatch/logic/CEvents.cpp

@@ -123,38 +123,68 @@ void CEvents::RemoveAllEvents()
     m_EventHashMap.clear();
 }
 
-void CEvents::PreEventPulse()
+void CEvents::PreEventPulse(CEventContext* pContext)
 {
+    assert(pContext);
+
     m_CancelledList.push_back(m_bEventCancelled);
+    m_ContextStack.push_back(pContext);
+
+    pContext->Reset();
+
     m_bEventCancelled = false;
     m_bWasEventCancelled = false;
     m_strLastError = "";
 }
 
-void CEvents::PostEventPulse()
+void CEvents::PostEventPulse(CEventContext* pContext)
 {
-    m_bWasEventCancelled = m_bEventCancelled;
+    assert(pContext);
+    assert(!m_ContextStack.empty());
+    assert(m_ContextStack.back() == pContext);
+
+    m_bWasEventCancelled = pContext->IsCancelled();
     m_bEventCancelled = m_CancelledList.back() ? true : false;
     m_CancelledList.pop_back();
+    m_ContextStack.pop_back();
 }
 
 void CEvents::CancelEvent(bool bCancelled)
 {
-    m_bEventCancelled = bCancelled;
+    CancelEvent(bCancelled, nullptr);
 }
 
 void CEvents::CancelEvent(bool bCancelled, const char* szReason)
 {
+    // ALWAYS set the old global variable for backward compatibility
     m_bEventCancelled = bCancelled;
-    m_strLastError = SStringX(szReason);
+    
+    // Also update context if it exists
+    if (!m_ContextStack.empty())
+    {
+        CEventContext* pCurrentContext = m_ContextStack.back();
+        if (bCancelled)
+            pCurrentContext->Cancel(szReason);
+        else
+            pCurrentContext->Reset();
+    }
+    
+    if (szReason)
+        m_strLastError = szReason;
 }
 
 bool CEvents::WasEventCancelled()
 {
-    return m_bWasEventCancelled;
+    if (!m_ContextStack.empty())
+        return m_ContextStack.back()->IsCancelled();
+    
+    return m_bEventCancelled || m_bWasEventCancelled;
 }
 
 const char* CEvents::GetLastError()
 {
+    if (!m_ContextStack.empty())
+        return m_ContextStack.back()->GetCancelReason().c_str();
+
     return m_strLastError;
 }

Server/mods/deathmatch/logic/CEvents.h

@@ -14,6 +14,7 @@
 #include <string>
 #include <list>
 #include <vector>
+#include "CEventContext.h"
 
 struct SEvent
 {
@@ -40,8 +41,8 @@ class CEvents
     CFastHashMap<SString, SEvent*>::const_iterator IterBegin() { return m_EventHashMap.begin(); };
     CFastHashMap<SString, SEvent*>::const_iterator IterEnd() { return m_EventHashMap.end(); };
 
-    void PreEventPulse();
-    void PostEventPulse();
+    void PreEventPulse(CEventContext* pContext);
+    void PostEventPulse(CEventContext* pContext);
 
     void        CancelEvent(bool bCancelled = true);
     void        CancelEvent(bool bCancelled, const char* szReason);
@@ -53,9 +54,10 @@ class CEvents
 
     CFastHashMap<SString, SEvent*> m_EventHashMap;
 
-    std::vector<int> m_CancelledList;
-    bool             m_bEventCancelled;
-    bool             m_bWasEventCancelled;
+    std::vector<int>               m_CancelledList;
+    bool                           m_bEventCancelled;
+    bool                           m_bWasEventCancelled;
+    SString                        m_strLastError;
 
-    SString m_strLastError;
+    std::vector<CEventContext*>    m_ContextStack;
 };

Server/mods/deathmatch/logic/CResource.AclRequest.cpp

@@ -369,51 +369,3 @@ bool CResource::FindAclRequest(SAclRequest& result)
 
     return pAclRight->GetAttributeValue("pending") != "";
 }
-
-std::string CResource::CalculateACLRequestFingerprint()
-{
-    std::string strPath;
-    if (!GetFilePath("meta.xml", strPath))
-        return {};
-
-    std::unique_ptr<CXMLFile> metaFile(g_pServerInterface->GetXML()->CreateXML(strPath.c_str()));
-    if (!metaFile || !metaFile->Parse())
-    {
-        return {};
-    }
-
-    CXMLNode* root = metaFile->GetRootNode();
-    if (!root)
-    {
-        return {};
-    }
-
-    std::ostringstream fingerprint;
-    CXMLNode* nodeAclRequest = root->FindSubNode("aclrequest", 0);
-    
-    if (nodeAclRequest)
-    {
-        for (std::uint8_t uiIndex = 0; true; uiIndex++)
-        {
-            CXMLNode* nodeRight = nodeAclRequest->FindSubNode("right", uiIndex);
-            if (!nodeRight)
-                break;
-
-            std::string strName = nodeRight->GetAttributeValue("name");
-            std::string strAccess = nodeRight->GetAttributeValue("access");
-
-            if (uiIndex > 0)
-                fingerprint << ";";
-                
-            fingerprint << strName << ":" << strAccess;
-        }
-    }
-    
-    return fingerprint.str();
-}
-
-bool CResource::HasACLRequestsChanged()
-{
-    std::string strCurrentFingerprint = CalculateACLRequestFingerprint();
-    return strCurrentFingerprint != m_strACLRequestFingerprint;
-}

Server/mods/deathmatch/logic/CResource.cpp

@@ -196,8 +196,6 @@ bool CResource::Load()
             else
                 RemoveAutoPermissions();
 
-            m_strACLRequestFingerprint = CalculateACLRequestFingerprint();
-
             // Find any map sync option
             m_bSyncMapElementData = true;
             m_bSyncMapElementDataDefined = false;
@@ -353,7 +351,6 @@ bool CResource::Unload()
     m_strResourceZip = "";
     m_strResourceCachePath = "";
     m_strResourceDirectoryPath = "";
-    m_strACLRequestFingerprint.clear();
     m_eState = EResourceState::None;
 
     return true;
@@ -405,8 +402,6 @@ CResource::~CResource()
 
 void CResource::TidyUp()
 {
-    RemoveAutoPermissions();
-
     // Close the zipfile stuff
     if (m_zipfile)
         unzClose(m_zipfile);
@@ -700,11 +695,6 @@ bool CResource::HasResourceChanged()
             return true;
     }
 
-    if (HasACLRequestsChanged())
-    {
-        return true;
-    }
-
     return false;
 }
 
@@ -1222,9 +1212,6 @@ bool CResource::Stop(bool bManualStop)
     // Clear the list of players where this resource is running
     std::exchange(m_isRunningForPlayer, {});
 
-    // Remove ACL permissions when stopping
-    RemoveAutoPermissions();
-
     OnResourceStateChange("loaded");
     m_eState = EResourceState::Loaded;
     return true;

Server/mods/deathmatch/logic/CResource.h

@@ -136,6 +136,7 @@ enum class EResourceState : unsigned char
 // It's a process-like environment for scripts, maps, images and other files.
 class CResource : public EHS
 {
+    friend class CResourceManager;  // Allow CResourceManager access to protected members
     using KeyValueMap = CFastHashMap<SString, SString>;
 
 public:
@@ -349,9 +350,6 @@ class CResource : public EHS
     void CommitAclRequest(const SAclRequest& request);
     bool FindAclRequest(SAclRequest& result);
 
-    std::string CalculateACLRequestFingerprint();
-    bool        HasACLRequestsChanged();
-
 private:
     bool CheckState();            // if the resource has no Dependents, stop it, if it has, start it. returns true if the resource is started.
     bool ReadIncludedResources(CXMLNode* pRoot);
@@ -453,7 +451,6 @@ class CResource : public EHS
     SString     m_strMinServerReason;
 
     CChecksum m_metaChecksum;            // Checksum of meta.xml last time this was loaded, generated in GenerateChecksums()
-    std::string m_strACLRequestFingerprint;
 
     uint                              m_uiFunctionRightCacheRevision = 0;
     CFastHashMap<lua_CFunction, bool> m_FunctionRightCacheMap;

Server/mods/deathmatch/logic/CResourceManager.cpp

@@ -172,27 +172,42 @@ bool CResourceManager::Refresh(bool bRefreshAll, const SString strJustThisResour
         if (!strJustThisResource.empty() && strJustThisResource != info.strName)
             continue;
 
-        if (!info.bPathIssue)
-        {
-            CResource* pResource = GetResource(info.strName);
+        if (info.bPathIssue)
+            continue;
 
-            if (bRefreshAll || !pResource || !pResource->CheckIfStartable())
-            {
-                if (g_pServerInterface->IsRequestingExit())
-                    return false;
+        auto* pResource = GetResource(info.strName);
 
-                // Add the resource
-                Load(!info.bIsDir, info.strAbsPath, info.strName);
-            }
-            else if (bRefreshAll && pResource && pResource->HasResourceChanged())
-            {
-                if (g_pServerInterface->IsRequestingExit())
-                    return false;
-                    
-                // Resource exists but has changed, reload it
-                Load(!info.bIsDir, info.strAbsPath, info.strName);
-            }
+        if (bRefreshAll || !pResource || !pResource->CheckIfStartable())
+        {
+            if (g_pServerInterface->IsRequestingExit())
+                return false;
+
+            // Add the resource
+            Load(!info.bIsDir, info.strAbsPath, info.strName);
+            continue;
         }
+
+        if (!pResource)
+            continue;
+
+        // For existing resources, refresh ACL permissions without full reload
+        std::string strPath;
+        if (!pResource->GetFilePath("meta.xml", strPath))
+            continue;
+
+        std::unique_ptr<CXMLFile> pMetaFile(g_pServerInterface->GetXML()->CreateXML(strPath.c_str()));
+        if (!pMetaFile || !pMetaFile->Parse())
+            continue;
+
+        CXMLNode* pRoot = pMetaFile->GetRootNode();
+        if (!pRoot)
+            continue;
+
+        CXMLNode* pNodeAclRequest = pRoot->FindSubNode("aclrequest", 0);
+        if (pNodeAclRequest)
+            pResource->RefreshAutoPermissions(pNodeAclRequest);
+        else
+            pResource->RemoveAutoPermissions();
     }
 
     marker.Set("AddNew");

Shared/mods/deathmatch/logic/CEventContext.h

@@ -0,0 +1,40 @@
+/*****************************************************************************
+ *
+ *  PROJECT:     Multi Theft Auto
+ *  LICENSE:     See LICENSE in the top level directory
+ *  FILE:        Shared/mods/deathmatch/logic/CEventContext.h
+ *  PURPOSE:     Per-event context for event dispatch and cancellation
+ *
+ *  Multi Theft Auto is available from https://www.multitheftauto.com/
+ *
+ *****************************************************************************/
+
+#pragma once
+
+#include <string>
+
+class CEventContext
+{
+public:
+    CEventContext() noexcept : m_isCancelled(false) {}
+
+    void Cancel(const char* reason = nullptr) noexcept
+    {
+        m_isCancelled = true;
+        if (reason)
+            m_cancelReason = reason;
+    }
+
+    bool               IsCancelled() const noexcept { return m_isCancelled; }
+    const std::string& GetCancelReason() const noexcept { return m_cancelReason; }
+
+    void Reset() noexcept
+    {
+        m_isCancelled = false;
+        m_cancelReason.clear();
+    }
+
+private:
+    bool        m_isCancelled;
+    std::string m_cancelReason;
+};