refactor: migrate from Signature to Fingerprint

BREAKING CHANGE: Not backwards compatible, since a lot of classes where renamed.
ReVanced · Jun 26, 2022 · 084078e · 084078e
1 parent e8be311
commit 084078e
Show file tree

Hide file tree

Showing 56 changed files with 535 additions and 496 deletions.
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -4,21 +4,26 @@ plugins {
 
 group = "app.revanced"
 
+val githubUsername: String = project.findProperty("gpr.user") as? String ?: System.getenv("GITHUB_ACTOR")
+val githubPassword: String = project.findProperty("gpr.key") as? String ?: System.getenv("GITHUB_TOKEN")
+
 repositories {
     mavenCentral()
+    mavenLocal()
     maven {
         url = uri("https://maven.pkg.github.com/revanced/revanced-patcher")
         credentials {
-            username = project.findProperty("gpr.user") as? String ?: System.getenv("GITHUB_ACTOR")
-            password = project.findProperty("gpr.key")  as? String ?: System.getenv("GITHUB_TOKEN")
+            username = githubUsername
+            password = githubPassword
         }
     }
 }
 
 dependencies {
     implementation(kotlin("stdlib"))
 
-    implementation("app.revanced:revanced-patcher:1.10.2")
+    implementation("app.revanced:revanced-patcher:2.0.0")
+    implementation("app.revanced:multidexlib2:2.5.2.r2")
 }
 
 tasks {

diff --git a/...signatures/AllCodecsReferenceSignature.kt → ...erprints/AllCodecsReferenceFingerprint.kt b/...signatures/AllCodecsReferenceSignature.kt → ...erprints/AllCodecsReferenceFingerprint.kt
@@ -1,24 +1,24 @@
-package app.revanced.patches.music.audio.codecs.signatures
+package app.revanced.patches.music.audio.codecs.fingerprints
 
 import app.revanced.patcher.annotation.Name
 import app.revanced.patcher.annotation.Version
 import app.revanced.patcher.extensions.or
-import app.revanced.patcher.signature.implementation.method.MethodSignature
-import app.revanced.patcher.signature.implementation.method.annotation.FuzzyPatternScanMethod
-import app.revanced.patcher.signature.implementation.method.annotation.MatchingMethod
+import app.revanced.patcher. fingerprint.method.impl.MethodFingerprint
+import app.revanced.patcher.fingerprint.method.annotation.FuzzyPatternScanMethod
+import app.revanced.patcher.fingerprint.method.annotation.MatchingMethod
 import app.revanced.patches.music.audio.codecs.annotations.CodecsUnlockCompatibility
 import org.jf.dexlib2.AccessFlags
 import org.jf.dexlib2.Opcode
 
-@Name("all-codecs-reference-signature")
+@Name("all-codecs-reference-fingerprint")
 @MatchingMethod(
     "Laari;",
     "b",
 )
 @FuzzyPatternScanMethod(2) // FIXME: Test this threshold and find the best value.
 @CodecsUnlockCompatibility
 @Version("0.0.1")
-object AllCodecsReferenceSignature : MethodSignature(
+object AllCodecsReferenceFingerprint : MethodFingerprint(
     "J", AccessFlags.PUBLIC or AccessFlags.FINAL, listOf("L"), listOf(
         Opcode.INVOKE_STATIC,
         Opcode.MOVE_RESULT_OBJECT,

diff --git a/.../codecs/signatures/CodecsLockSignature.kt → ...ecs/fingerprints/CodecsLockFingerprint.kt b/.../codecs/signatures/CodecsLockSignature.kt → ...ecs/fingerprints/CodecsLockFingerprint.kt
@@ -1,24 +1,24 @@
-package app.revanced.patches.music.audio.codecs.signatures
+package app.revanced.patches.music.audio.codecs.fingerprints
 
 import app.revanced.patcher.annotation.Name
 import app.revanced.patcher.annotation.Version
 import app.revanced.patcher.extensions.or
-import app.revanced.patcher.signature.implementation.method.MethodSignature
-import app.revanced.patcher.signature.implementation.method.annotation.FuzzyPatternScanMethod
-import app.revanced.patcher.signature.implementation.method.annotation.MatchingMethod
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import app.revanced.patcher.fingerprint.method.annotation.FuzzyPatternScanMethod
+import app.revanced.patcher.fingerprint.method.annotation.MatchingMethod
 import app.revanced.patches.music.audio.codecs.annotations.CodecsUnlockCompatibility
 import org.jf.dexlib2.AccessFlags
 import org.jf.dexlib2.Opcode
 
-@Name("codec-lock-signature")
+@Name("codec-lock-fingerprint")
 @MatchingMethod(
     "Labwj;",
     "a",
 )
 @FuzzyPatternScanMethod(2) // FIXME: Test this threshold and find the best value.
 @CodecsUnlockCompatibility
 @Version("0.0.1")
-object CodecsLockSignature : MethodSignature(
+object CodecsLockFingerprint : MethodFingerprint(
     "L", AccessFlags.PUBLIC or AccessFlags.STATIC, listOf("L", "L", "L", "L"), listOf(
         Opcode.INVOKE_STATIC,
         Opcode.MOVE_RESULT_OBJECT,

diff --git a/src/main/kotlin/app/revanced/patches/music/audio/codecs/patch/CodecsUnlockPatch.kt b/src/main/kotlin/app/revanced/patches/music/audio/codecs/patch/CodecsUnlockPatch.kt
@@ -3,16 +3,16 @@ package app.revanced.patches.music.audio.codecs.patch
 import app.revanced.patcher.annotation.Description
 import app.revanced.patcher.annotation.Name
 import app.revanced.patcher.annotation.Version
-import app.revanced.patcher.data.implementation.BytecodeData
-import app.revanced.patcher.data.implementation.toMethodWalker
+import app.revanced.patcher.data.impl.BytecodeData
+import app.revanced.patcher.data.impl.toMethodWalker
 import app.revanced.patcher.patch.annotations.Patch
-import app.revanced.patcher.patch.implementation.BytecodePatch
-import app.revanced.patcher.patch.implementation.misc.PatchResult
-import app.revanced.patcher.patch.implementation.misc.PatchResultSuccess
+import app.revanced.patcher.patch.impl.BytecodePatch
+import app.revanced.patcher.patch.PatchResult
+import app.revanced.patcher.patch.PatchResultSuccess
 import app.revanced.patcher.util.smali.toInstruction
 import app.revanced.patches.music.audio.codecs.annotations.CodecsUnlockCompatibility
-import app.revanced.patches.music.audio.codecs.signatures.AllCodecsReferenceSignature
-import app.revanced.patches.music.audio.codecs.signatures.CodecsLockSignature
+import app.revanced.patches.music.audio.codecs.fingerprints.AllCodecsReferenceFingerprint
+import app.revanced.patches.music.audio.codecs.fingerprints.CodecsLockFingerprint
 
 @Patch
 @Name("codecs-unlock")
@@ -21,19 +21,19 @@ import app.revanced.patches.music.audio.codecs.signatures.CodecsLockSignature
 @Version("0.0.1")
 class CodecsUnlockPatch : BytecodePatch(
     listOf(
-        CodecsLockSignature, AllCodecsReferenceSignature
+        CodecsLockFingerprint, AllCodecsReferenceFingerprint
     )
 ) {
     override fun execute(data: BytecodeData): PatchResult {
-        var result = CodecsLockSignature.result!!
+        var result = CodecsLockFingerprint.result!!
 
-        val implementation = result.method.implementation!!
+        val implementation = result.mutableMethod.implementation!!
 
-        val instructionIndex = result.scanResult.startIndex
+        val instructionIndex = result.patternScanResult!!.startIndex
 
-        result = AllCodecsReferenceSignature.result!!
+        result = AllCodecsReferenceFingerprint.result!!
         val codecMethod =
-            data.toMethodWalker(result.immutableMethod).nextMethod(result.scanResult.startIndex).getMethod()
+            data.toMethodWalker(result.method).nextMethod(result.patternScanResult!!.startIndex).getMethod()
 
         implementation.replaceInstruction(
             instructionIndex,

diff --git a/...p/revanced/patches/music/audio/exclusiveaudio/fingerprints/AudioOnlyEnablerFingerprint.kt b/...p/revanced/patches/music/audio/exclusiveaudio/fingerprints/AudioOnlyEnablerFingerprint.kt
@@ -0,0 +1,41 @@
+import app.revanced.patcher.annotation.Name
+import app.revanced.patcher.annotation.Version
+import app.revanced.patcher.extensions.or
+import app.revanced.patcher.fingerprint.method.annotation.DirectPatternScanMethod
+import app.revanced.patcher.fingerprint.method.annotation.MatchingMethod
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import app.revanced.patches.music.audio.exclusiveaudio.annotations.ExclusiveAudioCompatibility
+import org.jf.dexlib2.AccessFlags
+import org.jf.dexlib2.Opcode
+
+@Name("audio-only-enabler-fingerprint")
+@MatchingMethod(
+    "Lgmd;",
+    "d"
+)
+@DirectPatternScanMethod
+@ExclusiveAudioCompatibility
+@Version(
+    "0.0.1"
+)
+object  AudioOnlyEnablerFingerprint: MethodFingerprint(
+    "Z", AccessFlags.PUBLIC or AccessFlags.FINAL, listOf(), listOf(
+        Opcode.IGET_OBJECT,
+        Opcode.INVOKE_INTERFACE,
+        Opcode.MOVE_RESULT_OBJECT,
+        Opcode.IGET_OBJECT,
+        Opcode.INVOKE_INTERFACE,
+        Opcode.MOVE_RESULT_OBJECT,
+        Opcode.INVOKE_VIRTUAL,
+        Opcode.MOVE_RESULT_OBJECT,
+        Opcode.CHECK_CAST,
+        Opcode.IF_NEZ,
+        Opcode.IGET_OBJECT,
+        Opcode.INVOKE_VIRTUAL,
+        Opcode.MOVE_RESULT,
+        Opcode.GOTO,
+        Opcode.INVOKE_VIRTUAL,
+        Opcode.MOVE_RESULT,
+        Opcode.RETURN
+    )
+)
diff --git a/...dio/signatures/ExclusiveAudioSignature.kt → ...fingerprints/ExclusiveAudioFingerprint.kt b/...dio/signatures/ExclusiveAudioSignature.kt → ...fingerprints/ExclusiveAudioFingerprint.kt
@@ -1,23 +1,23 @@
-package app.revanced.patches.music.audio.exclusiveaudio.signatures
+package app.revanced.patches.music.audio.exclusiveaudio.fingerprints
 
 import app.revanced.patcher.annotation.Name
 import app.revanced.patcher.annotation.Version
 import app.revanced.patcher.extensions.or
-import app.revanced.patcher.signature.implementation.method.MethodSignature
-import app.revanced.patcher.signature.implementation.method.annotation.FuzzyPatternScanMethod
-import app.revanced.patcher.signature.implementation.method.annotation.MatchingMethod
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import app.revanced.patcher.fingerprint.method.annotation.FuzzyPatternScanMethod
+import app.revanced.patcher.fingerprint.method.annotation.MatchingMethod
 import app.revanced.patches.music.audio.exclusiveaudio.annotations.ExclusiveAudioCompatibility
 import org.jf.dexlib2.AccessFlags
 import org.jf.dexlib2.Opcode
 
-@Name("exclusive-audio-signature")
+@Name("exclusive-audio-fingerprints")
 @MatchingMethod(
     "Lgmd;", "c"
 )
 @FuzzyPatternScanMethod(2) // FIXME: Test this threshold and find the best value.
 @ExclusiveAudioCompatibility
 @Version("0.0.1")
-object ExclusiveAudioSignature : MethodSignature(
+object ExclusiveAudioFingerprint : MethodFingerprint(
     "V",
     AccessFlags.PUBLIC or AccessFlags.FINAL,
     listOf("L", "Z"),

diff --git a/src/main/kotlin/app/revanced/patches/music/audio/exclusiveaudio/patch/ExclusiveAudioPatch.kt b/src/main/kotlin/app/revanced/patches/music/audio/exclusiveaudio/patch/ExclusiveAudioPatch.kt
@@ -1,23 +1,19 @@
 package app.revanced.patches.music.audio.exclusiveaudio.patch
 
+import AudioOnlyEnablerFingerprint
 import app.revanced.patcher.annotation.Description
 import app.revanced.patcher.annotation.Name
 import app.revanced.patcher.annotation.Version
-import app.revanced.patcher.data.implementation.BytecodeData
-import app.revanced.patcher.extensions.or
+import app.revanced.patcher.data.impl.BytecodeData
+import app.revanced.patcher.extensions.addInstruction
+import app.revanced.patcher.extensions.replaceInstruction
+import app.revanced.patcher.fingerprint.method.utils.MethodFingerprintUtils.resolve
+import app.revanced.patcher.patch.PatchResult
+import app.revanced.patcher.patch.PatchResultSuccess
 import app.revanced.patcher.patch.annotations.Patch
-import app.revanced.patcher.patch.implementation.BytecodePatch
-import app.revanced.patcher.patch.implementation.misc.PatchResult
-import app.revanced.patcher.patch.implementation.misc.PatchResultError
-import app.revanced.patcher.patch.implementation.misc.PatchResultSuccess
-import app.revanced.patcher.signature.implementation.method.MethodSignature
-import app.revanced.patcher.signature.implementation.method.annotation.DirectPatternScanMethod
-import app.revanced.patcher.signature.implementation.method.annotation.MatchingMethod
-import app.revanced.patcher.util.smali.toInstruction
+import app.revanced.patcher.patch.impl.BytecodePatch
 import app.revanced.patches.music.audio.exclusiveaudio.annotations.ExclusiveAudioCompatibility
-import app.revanced.patches.music.audio.exclusiveaudio.signatures.ExclusiveAudioSignature
-import org.jf.dexlib2.AccessFlags
-import org.jf.dexlib2.Opcode
+import app.revanced.patches.music.audio.exclusiveaudio.fingerprints.ExclusiveAudioFingerprint
 
 @Patch
 @Name("exclusive-audio-playback")
@@ -26,44 +22,15 @@ import org.jf.dexlib2.Opcode
 @Version("0.0.1")
 class ExclusiveAudioPatch : BytecodePatch(
     listOf(
-        ExclusiveAudioSignature
+        ExclusiveAudioFingerprint
     )
 ) {
     override fun execute(data: BytecodeData): PatchResult {
-        val result = ExclusiveAudioSignature.result!!.findParentMethod(@Name("audio-only-enabler-method") @MatchingMethod(
-            "Lgmd;",
-            "d"
-        ) @DirectPatternScanMethod @ExclusiveAudioCompatibility @Version(
-            "0.0.1"
-        ) object : MethodSignature(
-            "Z", AccessFlags.PUBLIC or AccessFlags.FINAL, listOf(), listOf(
-                Opcode.IGET_OBJECT,
-                Opcode.INVOKE_INTERFACE,
-                Opcode.MOVE_RESULT_OBJECT,
-                Opcode.IGET_OBJECT,
-                Opcode.INVOKE_INTERFACE,
-                Opcode.MOVE_RESULT_OBJECT,
-                Opcode.INVOKE_VIRTUAL,
-                Opcode.MOVE_RESULT_OBJECT,
-                Opcode.CHECK_CAST,
-                Opcode.IF_NEZ,
-                Opcode.IGET_OBJECT,
-                Opcode.INVOKE_VIRTUAL,
-                Opcode.MOVE_RESULT,
-                Opcode.GOTO,
-                Opcode.INVOKE_VIRTUAL,
-                Opcode.MOVE_RESULT,
-                Opcode.RETURN
-            )
-        ) {}) ?: return PatchResultError("Required parent method could not be found.")
+        ExclusiveAudioFingerprint.resolve(data, AudioOnlyEnablerFingerprint.result!!.classDef)
 
-        val implementation = result.method.implementation!!
-        implementation.replaceInstruction(
-            implementation.instructions.count() - 1, "const/4 v0, 0x1".toInstruction()
-        )
-        implementation.addInstruction(
-            "return v0".toInstruction()
-        )
+        val method = ExclusiveAudioFingerprint.result!!.mutableMethod
+        method.replaceInstruction(method.implementation!!.instructions.count() - 1, "const/4 v0, 0x1")
+        method.addInstruction("return v0")
 
         return PatchResultSuccess()
     }

diff --git a/...tures/TasteBuilderConstructorSignature.kt → ...nts/TasteBuilderConstructorFingerprint.kt b/...tures/TasteBuilderConstructorSignature.kt → ...nts/TasteBuilderConstructorFingerprint.kt
@@ -1,23 +1,23 @@
-package app.revanced.patches.music.layout.tastebuilder.signatures
+package app.revanced.patches.music.layout.tastebuilder.fingerprints
 
 import app.revanced.patcher.annotation.Name
 import app.revanced.patcher.annotation.Version
 import app.revanced.patcher.extensions.or
-import app.revanced.patcher.signature.implementation.method.MethodSignature
-import app.revanced.patcher.signature.implementation.method.annotation.FuzzyPatternScanMethod
-import app.revanced.patcher.signature.implementation.method.annotation.MatchingMethod
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import app.revanced.patcher.fingerprint.method.annotation.FuzzyPatternScanMethod
+import app.revanced.patcher.fingerprint.method.annotation.MatchingMethod
 import app.revanced.patches.music.layout.tastebuilder.annotations.RemoveTasteBuilderCompatibility
 import org.jf.dexlib2.AccessFlags
 import org.jf.dexlib2.Opcode
 
-@Name("taste-builder-constructor")
+@Name("taste-builder-constructor-fingerprint")
 @MatchingMethod(
     "Lkyu;", "<init>"
 )
 @FuzzyPatternScanMethod(2) // FIXME: Test this threshold and find the best value.
 @RemoveTasteBuilderCompatibility
 @Version("0.0.1")
-object TasteBuilderConstructorSignature : MethodSignature(
+object TasteBuilderConstructorFingerprint : MethodFingerprint(
     "V", AccessFlags.PUBLIC or AccessFlags.CONSTRUCTOR, listOf("L", "L", "L", "L"), listOf(
         Opcode.INVOKE_DIRECT,
         Opcode.INVOKE_VIRTUAL,

diff --git a/...in/kotlin/app/revanced/patches/music/layout/tastebuilder/patch/RemoveTasteBuilderPatch.kt b/...in/kotlin/app/revanced/patches/music/layout/tastebuilder/patch/RemoveTasteBuilderPatch.kt
@@ -3,14 +3,14 @@ package app.revanced.patches.music.layout.tastebuilder.patch
 import app.revanced.patcher.annotation.Description
 import app.revanced.patcher.annotation.Name
 import app.revanced.patcher.annotation.Version
-import app.revanced.patcher.data.implementation.BytecodeData
+import app.revanced.patcher.data.impl.BytecodeData
 import app.revanced.patcher.extensions.addInstructions
 import app.revanced.patcher.patch.annotations.Patch
-import app.revanced.patcher.patch.implementation.BytecodePatch
-import app.revanced.patcher.patch.implementation.misc.PatchResult
-import app.revanced.patcher.patch.implementation.misc.PatchResultSuccess
+import app.revanced.patcher.patch.impl.BytecodePatch
+import app.revanced.patcher.patch.PatchResult
+import app.revanced.patcher.patch.PatchResultSuccess
 import app.revanced.patches.music.layout.tastebuilder.annotations.RemoveTasteBuilderCompatibility
-import app.revanced.patches.music.layout.tastebuilder.signatures.TasteBuilderConstructorSignature
+import app.revanced.patches.music.layout.tastebuilder.fingerprints.TasteBuilderConstructorFingerprint
 import org.jf.dexlib2.iface.instruction.formats.Instruction22c
 
 @Patch
@@ -20,18 +20,16 @@ import org.jf.dexlib2.iface.instruction.formats.Instruction22c
 @Version("0.0.1")
 class RemoveTasteBuilderPatch : BytecodePatch(
     listOf(
-        TasteBuilderConstructorSignature
+        TasteBuilderConstructorFingerprint
     )
 ) {
     override fun execute(data: BytecodeData): PatchResult {
-        val result = TasteBuilderConstructorSignature.result!!
-        val implementation = result.method.implementation!!
+        val result = TasteBuilderConstructorFingerprint.result!!
+        val method = result.mutableMethod
 
-        val insertIndex = result.scanResult.endIndex - 8
-
-        val register = (implementation.instructions[insertIndex] as Instruction22c).registerA
-
-        result.method.addInstructions(
+        val insertIndex = result.patternScanResult!!.endIndex - 8
+        val register = (method.implementation!!.instructions[insertIndex] as Instruction22c).registerA
+        method.addInstructions(
             insertIndex, """
                 const/16 v1, 0x8
                 invoke-virtual {v${register}, v1}, Landroid/view/View;->setVisibility(I)V