using System.Reflection;
using HarmonyLib;
namespace SPTarkov.Reflection.Patching;
///
/// Harmony patch wrapper class. See mod example 6.1 for usage.
///
///
/// A known limitation is that exceptions and logging are only sent to the console and are not color coded. There is no disk logging here.
///
public abstract class AbstractPatch
{
///
/// Method this patch targets
///
public MethodBase? TargetMethod { get; private set; }
///
/// Is this patch active?
///
public bool IsActive { get; private set; }
///
/// Is this patch managed by the PatchManager?
///
public bool IsManaged { get; private set; }
///
/// The harmony Id assigned to this patch, usually the name of the patch class.
///
public string HarmonyId
{
get { return _harmony?.Id ?? "Harmony Id is null for this patch"; }
}
private Harmony? _harmony;
private readonly List _prefixList;
private readonly List _postfixList;
private readonly List _transpilerList;
private readonly List _finalizerList;
private readonly List _ilManipulatorList;
///
/// Constructor
///
/// Name
protected AbstractPatch(string? name = null)
{
_harmony = new Harmony(name ?? GetType().Name);
_prefixList = GetPatchMethods(typeof(PatchPrefixAttribute));
_postfixList = GetPatchMethods(typeof(PatchPostfixAttribute));
_transpilerList = GetPatchMethods(typeof(PatchTranspilerAttribute));
_finalizerList = GetPatchMethods(typeof(PatchFinalizerAttribute));
_ilManipulatorList = GetPatchMethods(typeof(PatchIlManipulatorAttribute));
if (
_prefixList.Count == 0
&& _postfixList.Count == 0
&& _transpilerList.Count == 0
&& _finalizerList.Count == 0
&& _ilManipulatorList.Count == 0
)
{
throw new PatchException($"{GetType().Name}: At least one of the patch methods must be specified");
}
}
///
/// Get original method
///
/// Method
protected abstract MethodBase? GetTargetMethod();
///
/// Get HarmonyMethod from string
///
/// Attribute type
/// Method
private List GetPatchMethods(Type attributeType)
{
var T = GetType();
var methods = new List();
foreach (var method in T.GetMethods(BindingFlags.Static | BindingFlags.NonPublic | BindingFlags.Public | BindingFlags.DeclaredOnly))
{
if (method.GetCustomAttribute(attributeType) != null)
{
methods.Add(new HarmonyMethod(method));
}
}
return methods;
}
///
/// Apply patch to target
///
public void Enable()
{
// We never want to have duplicated patches, prevent it.
if (IsActive)
{
return;
}
TargetMethod = GetTargetMethod();
if (TargetMethod == null)
{
throw new PatchException($"{GetType().Name}: TargetMethod is null");
}
try
{
// Using null forgiving operator here because we want to throw if _harmony is null, but want the compiler to shut up about it.
foreach (var prefix in _prefixList)
{
_harmony!.Patch(TargetMethod, prefix: prefix);
}
foreach (var postfix in _postfixList)
{
_harmony!.Patch(TargetMethod, postfix: postfix);
}
foreach (var transpiler in _transpilerList)
{
_harmony!.Patch(TargetMethod, transpiler: transpiler);
}
foreach (var finalizer in _finalizerList)
{
_harmony!.Patch(TargetMethod, finalizer: finalizer);
}
foreach (var ilmanipulator in _ilManipulatorList)
{
_harmony!.Patch(TargetMethod, ilmanipulator: ilmanipulator);
}
ModPatchCache.AddPatch(this);
IsActive = true;
}
catch (Exception ex)
{
throw new Exception($"{GetType().Name}:", ex);
}
}
///
/// Internal use only, called from the patch manager.
///
/// Harmony instance of the patch manager
internal void Enable(Harmony harmony)
{
if (!ReferenceEquals(_harmony, harmony))
{
// Override the initial harmony instance with the PatchManagers instance
_harmony = harmony;
}
IsManaged = true;
Enable();
}
///
/// Remove applied patch from target
///
public void Disable()
{
// Nothing to disable
if (!IsActive)
{
return;
}
var target = GetTargetMethod();
if (target == null)
{
throw new PatchException($"{GetType().Name}: TargetMethod is null");
}
try
{
// Using null forgiving operator here because we want to throw if _harmony is null, but want the compiler to shut up about it.
_harmony!.Unpatch(target, HarmonyPatchType.All, _harmony.Id);
}
catch (Exception ex)
{
throw new PatchException($"{GetType().Name}:", ex);
}
if (!ModPatchCache.RemovePatch(this))
{
throw new PatchException($"{GetType().Name}: Target patch not present in cache, a mod is likely externally altering it.");
}
IsActive = false;
}
///
/// Internal use only, called from the patch manager.
///
/// Harmony instance of the patch manager
internal void Disable(Harmony harmony)
{
// Attempting to disable a patch that is not managed by the patch manager
if (harmony is null || !ReferenceEquals(_harmony, harmony))
{
throw new PatchException(
$"Patch: {GetType().Name} is attempting to be disabled internally while not managed by the patch manager."
);
}
Disable();
// This patch is no longer considered managed.
IsManaged = false;
}
}