chore(release): 5.0.1 [skip ci]

## [5.0.1](https://github.com/revanced/revanced-patcher/compare/v5.0.0...v5.0.1) (2022-09-23)

### Reverts

* revert breaking changes ([#106](https://github.com/revanced/revanced-patcher/issues/106)) ([124332f](124332f0e9))

.github/ISSUE_TEMPLATE/bug-issue.yml

@@ -58,3 +58,15 @@ body:
       description: Add additional context here.
     validations:
       required: false
+  - type: checkboxes
+    id: acknowledgements
+    attributes:
+      label: Acknowledgements
+      description: Your issue will be closed if you haven't done these steps.
+      options:
+        - label: I have searched the existing issues and this is a new and no duplicate or related to another open issue.
+          required: true
+        - label: I have written a short but informative title.
+          required: true
+        - label: I filled out all of the requested information in this issue properly.
+          required: true

.github/ISSUE_TEMPLATE/feature-issue.yml

@@ -43,4 +43,16 @@ body:
       label: Additional context
       description: Add additional context here.
     validations:
-      required: false
+      required: false
+  - type: checkboxes
+    id: acknowledgements
+    attributes:
+      label: Acknowledgements
+      description: Your issue will be closed if you haven't done these steps.
+      options:
+        - label: I have searched the existing issues and this is a new and no duplicate or related to another open issue.
+          required: true
+        - label: I have written a short but informative title.
+          required: true
+        - label: I filled out all of the requested information in this issue properly.
+          required: true

CHANGELOG.md

@@ -1,3 +1,57 @@
+## [5.0.1](https://github.com/revanced/revanced-patcher/compare/v5.0.0...v5.0.1) (2022-09-23)
+
+
+### Reverts
+
+* revert breaking changes ([#106](https://github.com/revanced/revanced-patcher/issues/106)) ([124332f](https://github.com/revanced/revanced-patcher/commit/124332f0e9bbdaf4f1aeeb6a31333093eeba1642))
+
+# [5.0.0](https://github.com/revanced/revanced-patcher/compare/v4.5.0...v5.0.0) (2022-09-21)
+
+
+### Bug Fixes
+
+* **tests:** access `patternScanResult` through `scanResult` ([76676fb](https://github.com/revanced/revanced-patcher/commit/76676fb5673a9e92517ee3a13943cdc98dd5102a))
+
+
+* refactor!: move utility methods from `MethodFingerprintUtils` `MethodFingerprint` ([d802ef8](https://github.com/revanced/revanced-patcher/commit/d802ef844edf65d4d26328d6ca72e3ddd5a52b15))
+* feat(fingerprint)!: `StringsScanResult` for `MethodFingerprint` ([3813e28](https://github.com/revanced/revanced-patcher/commit/3813e28ac2ad6710d8d935526ca679e7b1b5980e))
+
+
+### BREAKING CHANGES
+
+* Imports will have to be updated from `MethodFingerprintUtils` to `MethodFingerprint.Companion`.
+
+Signed-off-by: oSumAtrIX <johan.melkonyan1@web.de>
+* `MethodFingerprint` now has a field for `MethodFingerprintScanResult`. `MethodFingerprintScanResult` now holds the previous field `MethodFingerprint.patternScanResult`.
+
+Signed-off-by: oSumAtrIX <johan.melkonyan1@web.de>
+
+# [4.5.0](https://github.com/revanced/revanced-patcher/compare/v4.4.2...v4.5.0) (2022-09-20)
+
+
+### Features
+
+* section `acknowledgements` for issue templates ([a0cb449](https://github.com/revanced/revanced-patcher/commit/a0cb449c60310917141e2809abaa16b4174dc002))
+
+## [4.4.2](https://github.com/revanced/revanced-patcher/compare/v4.4.1...v4.4.2) (2022-09-18)
+
+
+### Bug Fixes
+
+* **fingerprint:** do not throw on `MethodFingerprint.result` getter ([2f7e62e](https://github.com/revanced/revanced-patcher/commit/2f7e62ef65422f2c75ef8b09b9cd27076e172b30))
+
+
+### Performance Improvements
+
+* **fingerprint:** do not resolve already resolved fingerprints ([4bfd7eb](https://github.com/revanced/revanced-patcher/commit/4bfd7ebff8b6623b0da4a46d6048bed08c5070d4))
+
+## [4.4.1](https://github.com/revanced/revanced-patcher/compare/v4.4.0...v4.4.1) (2022-09-14)
+
+
+### Bug Fixes
+
+* compare any methods parameters ([#101](https://github.com/revanced/revanced-patcher/issues/101)) ([085a3a4](https://github.com/revanced/revanced-patcher/commit/085a3a479d7bd411dcb0492b283daca538c824a1))
+
 # [4.4.0](https://github.com/revanced/revanced-patcher/compare/v4.3.0...v4.4.0) (2022-09-09)
 
 

build.gradle.kts

@@ -24,7 +24,7 @@ dependencies {
     implementation("xpp3:xpp3:1.1.4c")
     implementation("org.smali:smali:2.5.2")
     implementation("app.revanced:multidexlib2:2.5.2.r2")
-    implementation("org.apktool:apktool-lib:2.7.0-SNAPSHOT")
+    implementation("org.apktool:apktool-lib:2.8.1-SNAPSHOT")
 
     implementation(kotlin("reflect"))
     testImplementation(kotlin("test"))

gradle.properties

@@ -1,2 +1,2 @@
 kotlin.code.style = official
-version = 4.4.0
+version = 5.0.1

src/main/kotlin/app/revanced/patcher/Patcher.kt

@@ -8,7 +8,7 @@ import app.revanced.patcher.extensions.PatchExtensions.deprecated
 import app.revanced.patcher.extensions.PatchExtensions.patchName
 import app.revanced.patcher.extensions.PatchExtensions.sincePatcherVersion
 import app.revanced.patcher.extensions.nullOutputStream
-import app.revanced.patcher.fingerprint.method.utils.MethodFingerprintUtils.resolve
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint.Companion.resolve
 import app.revanced.patcher.patch.Patch
 import app.revanced.patcher.patch.PatchResult
 import app.revanced.patcher.patch.PatchResultError

src/main/kotlin/app/revanced/patcher/extensions/Extensions.kt

@@ -16,7 +16,6 @@ import org.jf.dexlib2.iface.instruction.Instruction
 import org.jf.dexlib2.iface.reference.MethodReference
 import org.jf.dexlib2.immutable.ImmutableMethod
 import org.jf.dexlib2.immutable.ImmutableMethodImplementation
-import org.jf.dexlib2.util.MethodUtil
 import java.io.OutputStream
 
 infix fun AccessFlags.or(other: AccessFlags) = this.value or other.value
@@ -47,16 +46,14 @@ fun MutableMethodImplementation.removeInstructions(index: Int, count: Int) {
 }
 
 /**
- * Compare a method to another, considering constructors and parameters.
+ * Compare a method to another, considering name and parameters.
  * @param otherMethod The method to compare against.
  * @return True if the methods match given the conditions.
  */
 fun Method.softCompareTo(otherMethod: MethodReference): Boolean {
-    if (MethodUtil.isConstructor(this) && !parametersEqual(
-            this.parameterTypes, otherMethod.parameterTypes
-        )
-    ) return false
-    return this.name == otherMethod.name
+    return this.name == otherMethod.name && parametersEqual(
+        this.parameterTypes, otherMethod.parameterTypes
+    )
 }
 
 /**

src/main/kotlin/app/revanced/patcher/fingerprint/method/utils/MethodFingerprintUtils.kt

@@ -1,158 +0,0 @@
-package app.revanced.patcher.fingerprint.method.utils
-
-import app.revanced.patcher.data.impl.BytecodeData
-import app.revanced.patcher.extensions.MethodFingerprintExtensions.fuzzyPatternScanMethod
-import app.revanced.patcher.extensions.MethodFingerprintExtensions.fuzzyScanThreshold
-import app.revanced.patcher.extensions.parametersEqual
-import app.revanced.patcher.fingerprint.method.annotation.FuzzyPatternScanMethod
-import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
-import app.revanced.patcher.fingerprint.method.impl.MethodFingerprintResult
-import app.revanced.patcher.fingerprint.method.impl.PatternScanResult
-import org.jf.dexlib2.Opcode
-import org.jf.dexlib2.iface.ClassDef
-import org.jf.dexlib2.iface.Method
-import org.jf.dexlib2.iface.instruction.Instruction
-import org.jf.dexlib2.iface.instruction.ReferenceInstruction
-import org.jf.dexlib2.iface.reference.StringReference
-
-/**
- * Utility class for [MethodFingerprint]
- */
-object MethodFingerprintUtils {
-    /**
-     * Resolve a list of [MethodFingerprint] against a list of [ClassDef].
-     * @param context The classes on which to resolve the [MethodFingerprint].
-     * @param forData The [BytecodeData] to host proxies.
-     * @return True if the resolution was successful, false otherwise.
-     */
-    fun Iterable<MethodFingerprint>.resolve(forData: BytecodeData, context: Iterable<ClassDef>) {
-        for (fingerprint in this) // For each fingerprint
-            classes@ for (classDef in context) // search through all classes for the fingerprint
-                if (fingerprint.resolve(forData, classDef))
-                    break@classes // if the resolution succeeded, continue with the next fingerprint
-    }
-
-    /**
-     * Resolve a [MethodFingerprint] against a [ClassDef].
-     * @param context The class on which to resolve the [MethodFingerprint].
-     * @param forData The [BytecodeData] to host proxies.
-     * @return True if the resolution was successful, false otherwise.
-     */
-    fun MethodFingerprint.resolve(forData: BytecodeData, context: ClassDef): Boolean {
-        for (method in context.methods)
-            if (this.resolve(forData, method, context))
-                return true
-        return false
-    }
-
-    /**
-     * Resolve a [MethodFingerprint] against a [Method].
-     * @param context The context on which to resolve the [MethodFingerprint].
-     * @param classDef The class of the matching [Method].
-     * @param forData The [BytecodeData] to host proxies.
-     * @return True if the resolution was successful, false otherwise.
-     */
-    fun MethodFingerprint.resolve(forData: BytecodeData, context: Method, classDef: ClassDef): Boolean {
-        val methodFingerprint = this
-
-        if (methodFingerprint.returnType != null && !context.returnType.startsWith(methodFingerprint.returnType))
-            return false
-
-        if (methodFingerprint.access != null && methodFingerprint.access != context.accessFlags)
-            return false
-
-
-        if (methodFingerprint.parameters != null && !parametersEqual(
-                methodFingerprint.parameters, // TODO: parseParameters()
-                context.parameterTypes
-            )
-        ) return false
-
-        if (methodFingerprint.customFingerprint != null && !methodFingerprint.customFingerprint!!(context))
-            return false
-
-        if (methodFingerprint.strings != null) {
-            val implementation = context.implementation ?: return false
-
-            val stringsList = methodFingerprint.strings.toMutableList()
-
-            implementation.instructions.forEach { instruction ->
-                if (instruction.opcode.ordinal != Opcode.CONST_STRING.ordinal) return@forEach
-
-                val string = ((instruction as ReferenceInstruction).reference as StringReference).string
-                val index = stringsList.indexOfFirst { it == string }
-                if (index != -1) stringsList.removeAt(index)
-            }
-
-            if (stringsList.isNotEmpty()) return false
-        }
-
-        val patternScanResult = if (methodFingerprint.opcodes != null) {
-            context.implementation?.instructions ?: return false
-
-            context.patternScan(methodFingerprint) ?: return false
-        } else null
-
-        methodFingerprint.result = MethodFingerprintResult(context, classDef, patternScanResult, forData)
-
-        return true
-    }
-
-    private fun Method.patternScan(
-        fingerprint: MethodFingerprint
-    ): PatternScanResult? {
-        val instructions = this.implementation!!.instructions
-        val fingerprintFuzzyPatternScanThreshold = fingerprint.fuzzyScanThreshold
-
-        val pattern = fingerprint.opcodes!!
-        val instructionLength = instructions.count()
-        val patternLength = pattern.count()
-
-        for (index in 0 until instructionLength) {
-            var patternIndex = 0
-            var threshold = fingerprintFuzzyPatternScanThreshold
-
-            while (index + patternIndex < instructionLength) {
-                val originalOpcode = instructions.elementAt(index + patternIndex).opcode
-                val patternOpcode = pattern.elementAt(patternIndex)
-
-                if (patternOpcode != null && patternOpcode.ordinal != originalOpcode.ordinal) {
-                    // reaching maximum threshold (0) means,
-                    // the pattern does not match to the current instructions
-                    if (threshold-- == 0) break
-                }
-
-                if (patternIndex < patternLength - 1) {
-                    // if the entire pattern has not been scanned yet
-                    // continue the scan
-                    patternIndex++
-                    continue
-                }
-                // the pattern is valid, generate warnings if fuzzyPatternScanMethod is FuzzyPatternScanMethod
-                val result = PatternScanResult(index, index + patternIndex)
-                if (fingerprint.fuzzyPatternScanMethod !is FuzzyPatternScanMethod) return result
-                result.warnings = result.createWarnings(pattern, instructions)
-
-                return result
-            }
-        }
-
-        return null
-    }
-}
-
-private fun PatternScanResult.createWarnings(
-    pattern: Iterable<Opcode?>, instructions: Iterable<Instruction>
-) = buildList {
-    for ((patternIndex, instructionIndex) in (this@createWarnings.startIndex until this@createWarnings.endIndex).withIndex()) {
-        val originalOpcode = instructions.elementAt(instructionIndex).opcode
-        val patternOpcode = pattern.elementAt(patternIndex)
-
-        if (patternOpcode == null || patternOpcode.ordinal == originalOpcode.ordinal) continue
-
-        this.add(PatternScanResult.Warning(originalOpcode, patternOpcode, instructionIndex, patternIndex))
-    }
-}
-
-private operator fun ClassDef.component1() = this
-private operator fun ClassDef.component2() = this.methods

src/test/kotlin/app/revanced/patcher/usage/bytecode/ExampleBytecodePatch.kt

@@ -58,7 +58,7 @@ class ExampleBytecodePatch : BytecodePatch(listOf(ExampleFingerprint)) {
         // Let's modify it, so it prints "Hello, ReVanced! Editing bytecode."
         // Get the start index of our opcode pattern.
         // This will be the index of the instruction with the opcode CONST_STRING.
-        val startIndex = result.patternScanResult!!.startIndex
+        val startIndex = result.scanResult.patternScanResult!!.startIndex
 
         implementation.replaceStringAt(startIndex, "Hello, ReVanced! Editing bytecode.")