Debugger plugin: Clean up event listeners before the plugin is delete…

…d to avoid use-after-free, fixes #322. (#323)
mikke89 · Jun 8, 2022 · 961747e · 961747e
1 parent 89a357b
commit 961747e
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 0 deletions.
diff --git a/Source/Debugger/DebuggerPlugin.cpp b/Source/Debugger/DebuggerPlugin.cpp
@@ -373,6 +373,13 @@ bool DebuggerPlugin::LoadLogElement()
 
 void DebuggerPlugin::ReleaseElements()
 {
+	// Erase event listeners to prevent crashes.
+	if (debug_context && info_element)
+	{
+		debug_context->RemoveEventListener("click", info_element, true);
+		debug_context->RemoveEventListener("mouseover", info_element, true);
+	}
+
 	if (host_context)
 	{
 		if (menu_element)
@@ -395,6 +402,10 @@ void DebuggerPlugin::ReleaseElements()
 			application_interface = nullptr;
 			log_interface.reset();
 		}
+
+		// Update to release documents before the plugin gets deleted.
+		// Helps avoid cleanup crashes.
+		host_context->Update();
 	}
 
 	if (debug_context)
@@ -404,6 +415,10 @@ void DebuggerPlugin::ReleaseElements()
 			debug_context->UnloadDocument(hook_element);
 			hook_element = nullptr;
 		}
+
+		// Update to release documents before the plugin gets deleted.
+		// Helps avoid cleanup crashes.
+		debug_context->Update();
 	}
 }
 

diff --git a/Source/Debugger/ElementInfo.cpp b/Source/Debugger/ElementInfo.cpp
@@ -59,6 +59,9 @@ ElementInfo::ElementInfo(const String& tag) : ElementDocument(tag)
 
 ElementInfo::~ElementInfo()
 {
+	RemoveEventListener(EventId::Click, this);
+	RemoveEventListener(EventId::Mouseover, this);
+	RemoveEventListener(EventId::Mouseout, this);
 }
 
 // Initialises the info element.

diff --git a/Source/Debugger/ElementLog.cpp b/Source/Debugger/ElementLog.cpp
@@ -80,6 +80,18 @@ ElementLog::ElementLog(const String& tag) : ElementDocument(tag)
 
 ElementLog::~ElementLog()
 {
+	RemoveEventListener(EventId::Click, this);
+
+	if (beacon && beacon->GetFirstChild())
+	{
+		beacon->GetFirstChild()->RemoveEventListener(EventId::Click, this);
+		beacon->GetParentNode()->RemoveChild(beacon);
+	}
+
+	if (message_content)
+	{
+		message_content->RemoveEventListener(EventId::Resize, this);
+	}
 }
 
 // Initialises the log element.