Add combined command for running both deobfuscators and the decompiler

Signed-off-by: Graham <gpe@openrs2.org>

.idea/runConfigurations/Deobfuscator.xml

@@ -0,0 +1,15 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Deobfuscator" type="JetRunConfigurationType">
+    <module name="openrs2.deob.main" />
+    <option name="VM_PARAMETERS" value="-Xmx3G" />
+    <option name="PROGRAM_PARAMETERS" value="" />
+    <option name="ALTERNATIVE_JRE_PATH_ENABLED" value="false" />
+    <option name="ALTERNATIVE_JRE_PATH" />
+    <option name="PASS_PARENT_ENVS" value="true" />
+    <option name="MAIN_CLASS_NAME" value="org.openrs2.deob.DeobfuscateCommandKt" />
+    <option name="WORKING_DIRECTORY" value="" />
+    <method v="2">
+      <option name="Make" enabled="true" />
+    </method>
+  </configuration>
+</component>

all/build.gradle.kts

@@ -18,9 +18,7 @@ dependencies {
     implementation(project(":archive"))
     implementation(project(":compress-cli"))
     implementation(project(":crc32"))
-    implementation(project(":decompiler"))
+    implementation(project(":deob"))
-    implementation(project(":deob-ast"))
-    implementation(project(":deob-bytecode"))
     implementation(project(":game"))
     implementation(project(":patcher"))
 }

all/src/main/kotlin/org/openrs2/Command.kt

@@ -5,9 +5,7 @@ import com.github.ajalt.clikt.core.subcommands
 import org.openrs2.archive.ArchiveCommand
 import org.openrs2.compress.cli.CompressCommand
 import org.openrs2.crc32.Crc32Command
-import org.openrs2.decompiler.DecompileCommand
+import org.openrs2.deob.DeobfuscateCommand
-import org.openrs2.deob.ast.DeobfuscateAstCommand
-import org.openrs2.deob.bytecode.DeobfuscateBytecodeCommand
 import org.openrs2.game.GameCommand
 import org.openrs2.patcher.PatchCommand
 
@@ -19,9 +17,7 @@ public class Command : NoOpCliktCommand(name = "openrs2") {
             ArchiveCommand(),
             CompressCommand(),
             Crc32Command(),
-            DecompileCommand(),
+            DeobfuscateCommand(),
-            DeobfuscateAstCommand(),
-            DeobfuscateBytecodeCommand(),
             GameCommand(),
             PatchCommand()
         )

decompiler/build.gradle.kts

@@ -10,9 +10,10 @@ application {
 }
 
 dependencies {
+    api(project(":deob-util"))
     api("com.github.ajalt.clikt:clikt:${Versions.clikt}")
+    api("com.google.inject:guice:${Versions.guice}")
 
-    implementation(project(":deob-util"))
     implementation(project(":util"))
     implementation("org.openrs2:fernflower:${Versions.fernflower}")
 }

decompiler/src/main/kotlin/org/openrs2/decompiler/DecompileCommand.kt

@@ -7,7 +7,7 @@ public fun main(args: Array<String>): Unit = DecompileCommand().main(args)
 
 public class DecompileCommand : CliktCommand(name = "decompile") {
     override fun run() {
-        val decompiler = Decompiler(Module.ALL)
+        val decompiler = Decompiler()
-        decompiler.run()
+        decompiler.run(Module.ALL)
     }
 }

decompiler/src/main/kotlin/org/openrs2/decompiler/Decompiler.kt

@@ -3,9 +3,11 @@ package org.openrs2.decompiler
 import org.jetbrains.java.decompiler.main.Fernflower
 import org.jetbrains.java.decompiler.main.extern.IFernflowerPreferences
 import org.openrs2.deob.util.Module
+import javax.inject.Singleton
 
-public class Decompiler(private val modules: Set<Module>) {
+@Singleton
-    public fun run() {
+public class Decompiler {
+    public fun run(modules: Set<Module>) {
         for (module in modules) {
             DecompilerIo(module.sources).use { io ->
                 val fernflower = Fernflower(io, io, OPTIONS, Slf4jFernflowerLogger)

deob-ast/build.gradle.kts

@@ -9,9 +9,10 @@ application {
 }
 
 dependencies {
+    api(project(":deob-util"))
     api("com.github.ajalt.clikt:clikt:${Versions.clikt}")
+    api("com.google.inject:guice:${Versions.guice}")
 
-    implementation(project(":deob-util"))
     implementation(project(":util"))
     implementation("com.github.javaparser:javaparser-symbol-solver-core:${Versions.javaParser}")
     implementation("com.google.guava:guava:${Versions.guava}")

deob-ast/src/main/kotlin/org/openrs2/deob/ast/DeobfuscateAstCommand.kt

@@ -6,7 +6,7 @@ import org.openrs2.deob.util.Module
 
 public fun main(args: Array<String>): Unit = DeobfuscateAstCommand().main(args)
 
-public class DeobfuscateAstCommand : CliktCommand(name = "deob-ast") {
+public class DeobfuscateAstCommand : CliktCommand(name = "ast") {
     override fun run() {
         val injector = Guice.createInjector(AstDeobfuscatorModule)
         val deobfuscator = injector.getInstance(AstDeobfuscator::class.java)

deob-bytecode/build.gradle.kts

@@ -10,6 +10,7 @@ application {
 
 dependencies {
     api("com.github.ajalt.clikt:clikt:${Versions.clikt}")
+    api("com.google.inject:guice:${Versions.guice}")
 
     implementation(project(":deob-annotations"))
     implementation(project(":deob-util"))

deob-bytecode/src/main/kotlin/org/openrs2/deob/bytecode/DeobfuscateBytecodeCommand.kt

@@ -6,7 +6,7 @@ import java.nio.file.Paths
 
 public fun main(args: Array<String>): Unit = DeobfuscateBytecodeCommand().main(args)
 
-public class DeobfuscateBytecodeCommand : CliktCommand(name = "deob-bytecode") {
+public class DeobfuscateBytecodeCommand : CliktCommand(name = "bytecode") {
     override fun run() {
         val injector = Guice.createInjector(BytecodeDeobfuscatorModule)
         val deobfuscator = injector.getInstance(BytecodeDeobfuscator::class.java)

deob/build.gradle.kts

@@ -0,0 +1,34 @@
+plugins {
+    `maven-publish`
+    application
+    kotlin("jvm")
+}
+
+application {
+    mainClass.set("org.openrs2.deob.DeobfuscateCommandKt")
+    applicationDefaultJvmArgs = listOf("-Xmx3G")
+}
+
+dependencies {
+    api("com.github.ajalt.clikt:clikt:${Versions.clikt}")
+
+    implementation(project(":decompiler"))
+    implementation(project(":deob-ast"))
+    implementation(project(":deob-bytecode"))
+}
+
+publishing {
+    publications.create<MavenPublication>("maven") {
+        from(components["java"])
+
+        pom {
+            packaging = "jar"
+            name.set("OpenRS2 Deobfuscator")
+            description.set(
+                """
+                A tool for deobfuscating and decompiling the RuneScape client.
+            """.trimIndent()
+            )
+        }
+    }
+}

deob/src/main/kotlin/org/openrs2/deob/DeobfuscateCommand.kt

@@ -0,0 +1,14 @@
+package org.openrs2.deob
+
+import com.github.ajalt.clikt.core.CliktCommand
+import com.google.inject.Guice
+
+public fun main(args: Array<String>): Unit = DeobfuscateCommand().main(args)
+
+public class DeobfuscateCommand : CliktCommand(name = "deob") {
+    override fun run() {
+        val injector = Guice.createInjector(DeobfuscatorModule)
+        val deobfuscator = injector.getInstance(Deobfuscator::class.java)
+        deobfuscator.run()
+    }
+}

deob/src/main/kotlin/org/openrs2/deob/Deobfuscator.kt

@@ -0,0 +1,35 @@
+package org.openrs2.deob
+
+import com.github.michaelbull.logging.InlineLogger
+import org.openrs2.decompiler.Decompiler
+import org.openrs2.deob.ast.AstDeobfuscator
+import org.openrs2.deob.bytecode.BytecodeDeobfuscator
+import org.openrs2.deob.util.Module
+import java.nio.file.Paths
+import javax.inject.Inject
+import javax.inject.Singleton
+
+@Singleton
+public class Deobfuscator @Inject constructor(
+    private val bytecodeDeobfuscator: BytecodeDeobfuscator,
+    private val decompiler: Decompiler,
+    private val astDeobfuscator: AstDeobfuscator
+) {
+    public fun run() {
+        logger.info { "Deobfuscating bytecode" }
+        bytecodeDeobfuscator.run(
+            input = Paths.get("nonfree/lib"),
+            output = Paths.get("nonfree/var/cache/deob")
+        )
+
+        logger.info { "Decompiling" }
+        decompiler.run(Module.ALL)
+
+        logger.info { "Deobfuscating AST" }
+        astDeobfuscator.run(Module.ALL)
+    }
+
+    private companion object {
+        private val logger = InlineLogger()
+    }
+}

deob/src/main/kotlin/org/openrs2/deob/DeobfuscatorModule.kt

@@ -0,0 +1,12 @@
+package org.openrs2.deob
+
+import com.google.inject.AbstractModule
+import org.openrs2.deob.ast.AstDeobfuscatorModule
+import org.openrs2.deob.bytecode.BytecodeDeobfuscatorModule
+
+public object DeobfuscatorModule : AbstractModule() {
+    override fun configure() {
+        install(AstDeobfuscatorModule)
+        install(BytecodeDeobfuscatorModule)
+    }
+}

settings.gradle.kts

@@ -13,6 +13,7 @@ include(
     "crypto",
     "db",
     "decompiler",
+    "deob",
     "deob-annotations",
     "deob-ast",
     "deob-bytecode",