From f71059ce209a8b79641bd8c78ed9ac5bedd2c9b2 Mon Sep 17 00:00:00 2001 From: Max Weber Date: Fri, 9 Feb 2018 16:40:28 -0700 Subject: [PATCH] Add raw injector to hook the script interpreter --- .../net/runelite/client/callback/Hooks.java | 24 ----- .../net/runelite/client/callback/Hooks.java | 6 -- .../net/runelite/mixins/ScriptVMMixin.java | 97 +++++++++++++++++++ .../net/runelite/rs/api/RSScriptEvent.java | 28 +----- 4 files changed, 100 insertions(+), 55 deletions(-) create mode 100644 runelite-mixins/src/main/java/net/runelite/mixins/ScriptVMMixin.java rename runelite-mixins/src/main/java/net/runelite/mixins/VmMixin.java => runescape-api/src/main/java/net/runelite/rs/api/RSScriptEvent.java (65%) diff --git a/runelite-client/src/main/java/net/runelite/client/callback/Hooks.java b/runelite-client/src/main/java/net/runelite/client/callback/Hooks.java index 42ad695b22..351a5377f7 100644 --- a/runelite-client/src/main/java/net/runelite/client/callback/Hooks.java +++ b/runelite-client/src/main/java/net/runelite/client/callback/Hooks.java @@ -45,8 +45,6 @@ import net.runelite.api.PacketBuffer; import net.runelite.api.Point; import net.runelite.api.Projectile; import net.runelite.api.Region; -import net.runelite.api.Script; -import net.runelite.api.events.ScriptEvent; import net.runelite.client.RuneLite; import net.runelite.client.chat.ChatMessageManager; import net.runelite.client.game.DeathChecker; @@ -170,28 +168,6 @@ public class Hooks } } - /** - * - * @param opcode - * @param script - * @param isOne - * @return 0 halts, 1 continues, 2 throws - */ - public static int runeliteExecute(int opcode, Script script, boolean isOne) - { - String[] stringStack = client.getStringStack(); - int stackSize = client.getStringStackSize(); - String eventName = stringStack[--stackSize]; - client.setStringStackSize(stackSize); - - ScriptEvent event = new ScriptEvent(); - event.setScript(script); - event.setEventName(eventName); - eventBus.post(event); - - return 1; - } - public static void menuActionHook(int actionParam, int widgetId, int menuAction, int id, String menuOption, String menuTarget, int var6, int var7) { /* Along the way, the RuneScape client may change a menuAction by incrementing it with 2000. diff --git a/runelite-mixins/src/main/java/net/runelite/client/callback/Hooks.java b/runelite-mixins/src/main/java/net/runelite/client/callback/Hooks.java index a904a09c54..03d5b49020 100644 --- a/runelite-mixins/src/main/java/net/runelite/client/callback/Hooks.java +++ b/runelite-mixins/src/main/java/net/runelite/client/callback/Hooks.java @@ -25,7 +25,6 @@ package net.runelite.client.callback; import com.google.common.eventbus.EventBus; -import net.runelite.api.Script; import org.slf4j.Logger; /** @@ -38,9 +37,4 @@ public class Hooks public static Logger log; public static EventBus eventBus; - - public static int runeliteExecute(int opcode, Script script, boolean isOne) - { - throw new RuntimeException(); - } } diff --git a/runelite-mixins/src/main/java/net/runelite/mixins/ScriptVMMixin.java b/runelite-mixins/src/main/java/net/runelite/mixins/ScriptVMMixin.java new file mode 100644 index 0000000000..126ba1aced --- /dev/null +++ b/runelite-mixins/src/main/java/net/runelite/mixins/ScriptVMMixin.java @@ -0,0 +1,97 @@ +/* + * Copyright (c) 2018 Abex + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR + * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +package net.runelite.mixins; + +import net.runelite.api.Client; +import net.runelite.api.events.ScriptEvent; +import net.runelite.api.mixins.Copy; +import net.runelite.api.mixins.Inject; +import net.runelite.api.mixins.Mixin; +import net.runelite.api.mixins.Replace; +import net.runelite.api.mixins.Shadow; +import net.runelite.client.callback.Hooks; +import net.runelite.rs.api.RSClient; +import net.runelite.rs.api.RSScript; +import net.runelite.rs.api.RSScriptEvent; + +import static net.runelite.api.Opcodes.RUNELITE_EXECUTE; + +@Mixin(RSClient.class) +public abstract class ScriptVMMixin implements RSClient +{ + @Shadow("clientInstance") + private static Client client; + + // This field is set by the ScriptVM raw injector + @Inject + private static RSScript currentScript; + + // This field is set by the ScriptVM raw injector + @Inject + private static int currentScriptPC; + + // Call is injected into runScript by the ScriptVM raw injector + @Inject + static boolean vmExecuteOpcode(int opcode) + { + if (opcode == RUNELITE_EXECUTE) + { + if (currentScript.getInstructions()[currentScriptPC] != RUNELITE_EXECUTE) + { + throw new AssertionError("currentScriptPC is wrong"); + } + + int stringStackSize = client.getStringStackSize(); + String stringOp = client.getStringStack()[--stringStackSize]; + client.setStringStackSize(stringStackSize); + + ScriptEvent event = new ScriptEvent(); + event.setScript(currentScript); + event.setEventName(stringOp); + Hooks.eventBus.post(event); + return true; + } + return false; + } + + @Copy("runScript") + static void rs$runScript(RSScriptEvent event, int maxExecutionTime) + { + throw new RuntimeException(); + } + + @Replace("runScript") + static void rl$runScript(RSScriptEvent event, int maxExecutionTime) + { + try + { + rs$runScript(event, maxExecutionTime); + } + finally + { + currentScript = null; + } + } +} diff --git a/runelite-mixins/src/main/java/net/runelite/mixins/VmMixin.java b/runescape-api/src/main/java/net/runelite/rs/api/RSScriptEvent.java similarity index 65% rename from runelite-mixins/src/main/java/net/runelite/mixins/VmMixin.java rename to runescape-api/src/main/java/net/runelite/rs/api/RSScriptEvent.java index 42dd3eb90e..91ecb4df76 100644 --- a/runelite-mixins/src/main/java/net/runelite/mixins/VmMixin.java +++ b/runescape-api/src/main/java/net/runelite/rs/api/RSScriptEvent.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2018, Adam + * Copyright (c) 2018 Abex * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -22,30 +22,8 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ -package net.runelite.mixins; +package net.runelite.rs.api; -import static net.runelite.api.Opcodes.RUNELITE_EXECUTE; -import net.runelite.api.Script; -import net.runelite.api.mixins.Copy; -import net.runelite.api.mixins.Replace; -import net.runelite.client.callback.Hooks; - -//@Mixin(RSClient.class) -public abstract class VmMixin +public interface RSScriptEvent { - @Copy("execute6500") - static int rs$execute6500(int opcode, Script script, boolean isOne) - { - throw new RuntimeException(); - } - - @Replace("execute6500") - static int rl$execute6500(int opcode, Script script, boolean isOne) - { - if (opcode == RUNELITE_EXECUTE) - { - return Hooks.runeliteExecute(opcode, script, isOne); - } - return rs$execute6500(opcode, script, isOne); - } }