DHooks: Feature dtor hook cleanup

Author: Kenzzer

extensions/dhooks/src/handle.cpp

@@ -170,7 +170,7 @@ bool DynamicDetour::Disable(SourcePawn::IPluginFunction* callback, sp::HookMode
 	return true;
 }
 
-std::uint32_t DynamicHook::AddHook(SourcePawn::IPluginFunction* callback, SourcePawn::IPluginFunction* rm_callback, sp::HookMode mode, void* obj) {
+std::uint32_t DynamicHook::AddHook(SourcePawn::IPluginFunction* callback, SourcePawn::IPluginFunction* rm_callback, sp::HookMode mode, void* obj, bool dtor_cleanup) {
 	if (!this->IsImmutable()) {
 		return 0;
 	}
@@ -189,31 +189,33 @@ std::uint32_t DynamicHook::AddHook(SourcePawn::IPluginFunction* callback, Source
 		return 0;
 	}
 
-	auto it = locals::class_dynamichooks.find((CGenericClass*)obj);
-	if (it == locals::class_dynamichooks.end()) {
-		auto insert = locals::class_dynamichooks.emplace((CGenericClass*)obj, std::vector<std::uint32_t>());
-		if (insert.second == false) {
-			return id;
-		}
-		it = insert.first;
-
-		if (locals::class_vtables.find(vtable) == locals::class_vtables.end()) {
-			// Hook the virtual destructor, and perform hook cleaning actions under there
-			KHook::SetupVirtualHook(
-				vtable,
-				DTOR_VTABLE_INDEX,
-				nullptr,
-				nullptr,
-				KHook::ExtractMFP(&CGenericClass::KHook_Detour_PRE),
-				nullptr,
-				KHook::ExtractMFP(&CGenericClass::KHook_Make_Return),
-				KHook::ExtractMFP(&CGenericClass::KHook_Make_CallOriginal),
-				true
-			);
-			locals::class_vtables.insert(vtable);
+	if (dtor_cleanup) {
+		auto it = locals::class_dynamichooks.find((CGenericClass*)obj);
+		if (it == locals::class_dynamichooks.end()) {
+			auto insert = locals::class_dynamichooks.emplace((CGenericClass*)obj, std::vector<std::uint32_t>());
+			if (insert.second == false) {
+				return id;
+			}
+			it = insert.first;
+
+			if (locals::class_vtables.find(vtable) == locals::class_vtables.end()) {
+				// Hook the virtual destructor, and perform hook cleaning actions under there
+				KHook::SetupVirtualHook(
+					vtable,
+					DTOR_VTABLE_INDEX,
+					nullptr,
+					nullptr,
+					KHook::ExtractMFP(&CGenericClass::KHook_Detour_PRE),
+					nullptr,
+					KHook::ExtractMFP(&CGenericClass::KHook_Make_Return),
+					KHook::ExtractMFP(&CGenericClass::KHook_Make_CallOriginal),
+					true
+				);
+				locals::class_vtables.insert(vtable);
+			}
 		}
+		it->second.push_back(id);
 	}
-	it->second.push_back(id);
 	return id;
 }
 

extensions/dhooks/src/handle.hpp

@@ -111,7 +111,7 @@ class DynamicHook : public HookSetup {
 		return _default_callback;
 	}
 
-	std::uint32_t AddHook(SourcePawn::IPluginFunction* callback, SourcePawn::IPluginFunction* rm_callback, sp::HookMode, void* obj);
+	std::uint32_t AddHook(SourcePawn::IPluginFunction* callback, SourcePawn::IPluginFunction* rm_callback, sp::HookMode, void* obj, bool dtor_cleanup);
 	bool RemoveHook(std::uint32_t id);
 	static cell_t FindByHookID(std::uint32_t id);
 protected:

extensions/dhooks/src/natives/dynamichook.cpp

@@ -87,7 +87,7 @@ cell_t DynamicHook_HookEntity(SourcePawn::IPluginContext* context, const cell_t*
 	auto removal_callback = context->GetFunctionById(params[5]);
 
 	dynhook->SetImmutable();
-	return dynhook->AddHook(callback, removal_callback, mode, entity);
+	return dynhook->AddHook(callback, removal_callback, mode, entity, true);
 }
 
 cell_t DynamicHook_DHookEntity(SourcePawn::IPluginContext* context, const cell_t* params) {
@@ -119,7 +119,7 @@ cell_t DynamicHook_DHookEntity(SourcePawn::IPluginContext* context, const cell_t
 	}
 
 	dynhook->SetImmutable();
-	return dynhook->AddHook(callback, removal_callback, (post) ? sp::HookMode::Hook_Post : sp::HookMode::Hook_Pre, entity);
+	return dynhook->AddHook(callback, removal_callback, (post) ? sp::HookMode::Hook_Post : sp::HookMode::Hook_Pre, entity, true);
 }
 
 cell_t DynamicHook_HookGamerules(SourcePawn::IPluginContext* context, const cell_t* params) {
@@ -155,7 +155,7 @@ cell_t DynamicHook_HookGamerules(SourcePawn::IPluginContext* context, const cell
 	auto removal_callback = context->GetFunctionById(params[4]);
 
 	dynhook->SetImmutable();
-	return dynhook->AddHook(callback, removal_callback, mode, gamerules);
+	return dynhook->AddHook(callback, removal_callback, mode, gamerules, false);
 }
 
 cell_t DynamicHook_DHookGamerules(SourcePawn::IPluginContext* context, const cell_t* params) {
@@ -191,7 +191,7 @@ cell_t DynamicHook_DHookGamerules(SourcePawn::IPluginContext* context, const cel
 	}
 
 	dynhook->SetImmutable();
-	return dynhook->AddHook(callback, removal_callback, (post) ? sp::HookMode::Hook_Post : sp::HookMode::Hook_Pre, gamerules);
+	return dynhook->AddHook(callback, removal_callback, (post) ? sp::HookMode::Hook_Post : sp::HookMode::Hook_Pre, gamerules, false);
 }
 
 cell_t DynamicHook_HookRaw(SourcePawn::IPluginContext* context, const cell_t* params) {
@@ -214,7 +214,7 @@ cell_t DynamicHook_HookRaw(SourcePawn::IPluginContext* context, const cell_t* pa
 	}
 
 	dynhook->SetImmutable();
-	return dynhook->AddHook(callback, nullptr, mode, addr);
+	return dynhook->AddHook(callback, nullptr, mode, addr, (params[0] >= 5 && params[5] != 0));
 }
 
 cell_t DynamicHook_DHookRaw(SourcePawn::IPluginContext* context, const cell_t* params) {
@@ -243,7 +243,7 @@ cell_t DynamicHook_DHookRaw(SourcePawn::IPluginContext* context, const cell_t* p
 	}
 
 	dynhook->SetImmutable();
-	return dynhook->AddHook(callback, removal_callback, (post) ? sp::HookMode::Hook_Post : sp::HookMode::Hook_Pre, addr);
+	return dynhook->AddHook(callback, removal_callback, (post) ? sp::HookMode::Hook_Post : sp::HookMode::Hook_Pre, addr, false);
 }
 
 cell_t DynamicHook_RemoveHook(SourcePawn::IPluginContext* context, const cell_t* params) {

plugins/include/dhooks.inc

@@ -545,10 +545,11 @@ methodmap DynamicHook < DHookSetup
 	//                        You can access the parameters and get/set the return value.
 	// @param addr          This pointer address.
 	// @param callback      Callback function.
+	// @param dtorcleanup   If object has a virtual dtor, pass true for automatic hook cleanup.
 	//
 	// @return              A hookid on success, INVALID_HOOK_ID otherwise.
 	// @error               Invalid setup handle, invalid address, invalid hook type or invalid callback.
-	public native int HookRaw(HookMode mode, Address addr, DHookCallback callback);
+	public native int HookRaw(HookMode mode, Address addr, DHookCallback callback, bool dtorcleanup = false);
 
 	// Remove hook by hook id.
 	//