chore(release): 2.5.2 [skip ci]

## [2.5.2](https://github.com/revanced/revanced-patcher/compare/v2.5.1...v2.5.2) (2022-07-24)

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Create a bug report on the patcher. Do not submit suggestions for patches here.
+title: 'problem: some problem'
+labels: bug
+assignees: oSumAtrIX, Sculas
+
+---
+
+## 🐞 Issue
+
+<!-- Describe your issue in detail here -->
+
+## ⚙ Reproduce
+
+<!-- Include your environment and steps to reproduce the issue as detailed as possible -->
+
+## 🛠 Solution
+
+<!-- If applicable, add a possible solution -->
+
+## ⚠ Additional context
+
+<!-- Add any other context about the problem here -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+name: Feature request
+about: Suggest a change for the patcher. Do not submit suggestions for patches here.
+title: 'feat: some feature'
+labels: feature-request
+assignees: ''
+
+---
+
+## 🐞 Issue
+
+<!-- Explain here, what the current problem is and why it leads you to request a feature change -->
+
+## ❗ Solution
+
+<!-- Explain how your current issue can be solved -->
+
+## ❓ Motivation
+
+<!-- Explain why your feature should be considered -->
+
+## ⚠ Additional context
+
+<!-- Add any other context or screenshots about the feature request here -->

.github/workflows/release.yml

@@ -28,8 +28,6 @@ jobs:
         uses: actions/setup-node@v2
         with:
           node-version: "lts/*"
-      - name: Make gradlew executable
-        run: chmod +x gradlew
       - name: Build with Gradle
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.releaserc

@@ -7,7 +7,11 @@
     }
   ],
   "plugins": [
-    "@semantic-release/commit-analyzer",
+    ["@semantic-release/commit-analyzer", {
+      "releaseRules": [
+        {"type": "build", "release": "patch"}
+      ]
+    }],
     "@semantic-release/release-notes-generator",
     "@semantic-release/changelog",
     "gradle-semantic-release-plugin",

build.gradle.kts

@@ -1,38 +1,32 @@
 plugins {
-    kotlin("jvm") version "1.6.21"
+    kotlin("jvm") version "1.7.0"
     java
     `maven-publish`
 }
 
 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()
     maven {
         url = uri("https://maven.pkg.github.com/revanced/multidexlib2")
         credentials {
-            // DO NOT set these variables in the project's gradle.properties.
-            // Instead, you should set them in:
-            // Windows: %homepath%\.gradle\gradle.properties
-            // Linux: ~/.gradle/gradle.properties
-            username =
-                project.findProperty("gpr.user") as String? ?: System.getenv("GITHUB_ACTOR") // DO NOT CHANGE!
-            password =
-                project.findProperty("gpr.key") as String? ?: System.getenv("GITHUB_TOKEN") // DO NOT CHANGE!
+            username = githubUsername
+            password = githubPassword
         }
     }
 }
 
 dependencies {
-    implementation(kotlin("stdlib"))
-
-    api("xpp3:xpp3:1.1.4c")
-    api("org.apktool:apktool-lib:2.6.1")
-    api("app.revanced:multidexlib2:2.5.2.r2")
-    api("org.smali:smali:2.5.2")
+    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")
 
     testImplementation(kotlin("test"))
-    implementation(kotlin("reflect"))
 }
 
 tasks {
@@ -46,14 +40,11 @@ tasks {
 
 java {
     withSourcesJar()
-    withJavadocJar()
 }
 
-val isGitHubCI = System.getenv("GITHUB_ACTOR") != null
-
 publishing {
     repositories {
-        if (isGitHubCI) {
+        if (System.getenv("GITHUB_ACTOR") != null)
             maven {
                 name = "GitHubPackages"
                 url = uri("https://maven.pkg.github.com/revanced/revanced-patcher")
@@ -62,13 +53,12 @@ publishing {
                     password = System.getenv("GITHUB_TOKEN")
                 }
             }
-        } else {
+        else
             mavenLocal()
-        }
     }
     publications {
         register<MavenPublication>("gpr") {
             from(components["java"])
         }
     }
-}
+}

gradle.properties

@@ -1,2 +1,2 @@
 kotlin.code.style = official
-version = 1.0.0
+version = 2.5.2

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

@@ -0,0 +1,19 @@
+package app.revanced.patcher
+
+import app.revanced.patcher.data.Data
+import app.revanced.patcher.data.PackageMetadata
+import app.revanced.patcher.data.impl.BytecodeData
+import app.revanced.patcher.data.impl.ResourceData
+import app.revanced.patcher.patch.Patch
+import org.jf.dexlib2.iface.ClassDef
+import java.io.File
+
+data class PatcherData(
+    internal val internalClasses: MutableList<ClassDef>,
+    internal val resourceCacheDirectory: String,
+    val packageMetadata: PackageMetadata
+) {
+    internal val patches = mutableListOf<Class<out Patch<Data>>>()
+    internal val bytecodeData = BytecodeData(internalClasses)
+    internal val resourceData = ResourceData(File(resourceCacheDirectory))
+}

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

@@ -1,15 +1,23 @@
 package app.revanced.patcher
 
+import app.revanced.patcher.logging.Logger
+import app.revanced.patcher.logging.impl.NopLogger
 import java.io.File
 
 /**
+ * Options for the [Patcher].
  * @param inputFile The input file (usually an apk file).
  * @param resourceCacheDirectory Directory to cache resources.
  * @param patchResources Weather to use the resource patcher. Resources will still need to be decoded.
+ * @param aaptPath Optional path to a custom aapt binary.
+ * @param frameworkFolderLocation Optional path to a custom framework folder.
+ * @param logger Custom logger implementation for the [Patcher].
  */
 data class PatcherOptions(
     internal val inputFile: File,
-    // TODO: maybe a file system in memory is better. Could cause high memory usage.
     internal val resourceCacheDirectory: String,
-    internal val patchResources: Boolean = false
+    internal val patchResources: Boolean = false,
+    internal val aaptPath: String = "",
+    internal val frameworkFolderLocation: String? = null,
+    internal val logger: Logger = NopLogger
 )

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

@@ -0,0 +1,16 @@
+package app.revanced.patcher
+
+import app.revanced.patcher.util.dex.DexFile
+import java.io.File
+
+/**
+ * The result of a patcher.
+ * @param dexFiles The patched dex files.
+ * @param doNotCompress List of relative paths to files to exclude from compressing.
+ * @param resourceFile File containing resources that need to be extracted into the APK.
+ */
+data class PatcherResult(
+    val dexFiles: List<DexFile>,
+    val doNotCompress: List<String>? = null,
+    val resourceFile: File?
+)

src/main/kotlin/app/revanced/patcher/annotation/CompatibilityAnnotation.kt

@@ -1,11 +1,11 @@
 package app.revanced.patcher.annotation
 
-import app.revanced.patcher.patch.base.Patch
-import app.revanced.patcher.signature.implementation.method.MethodSignature
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import app.revanced.patcher.patch.Patch
 
 /**
- * Annotation to constrain a [Patch] or [MethodSignature] to compatible packages.
- * @param compatiblePackages A list of packages a [Patch] or [MethodSignature] is compatible with.
+ * Annotation to constrain a [Patch] or [MethodFingerprint] to compatible packages.
+ * @param compatiblePackages A list of packages a [Patch] or [MethodFingerprint] is compatible with.
  */
 @Target(AnnotationTarget.CLASS)
 @Retention(AnnotationRetention.RUNTIME)
@@ -17,7 +17,7 @@ annotation class Compatibility(
 /**
  * Annotation to represent packages a patch can be compatible with.
  * @param name The package identifier name.
- * @param versions The versions of the package the [Patch] or [MethodSignature]is compatible with.
+ * @param versions The versions of the package the [Patch] or [MethodFingerprint]is compatible with.
  */
 @Target()
 @Retention(AnnotationRetention.RUNTIME)

src/main/kotlin/app/revanced/patcher/annotation/MetadataAnnotation.kt

@@ -1,11 +1,11 @@
 package app.revanced.patcher.annotation
 
-import app.revanced.patcher.patch.base.Patch
-import app.revanced.patcher.signature.implementation.method.MethodSignature
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import app.revanced.patcher.patch.Patch
 
 /**
- * Annotation to name a [Patch] or [MethodSignature].
- * @param name A suggestive name for the [Patch] or [MethodSignature].
+ * Annotation to name a [Patch] or [MethodFingerprint].
+ * @param name A suggestive name for the [Patch] or [MethodFingerprint].
  */
 @Target(AnnotationTarget.CLASS)
 @Retention(AnnotationRetention.RUNTIME)
@@ -15,8 +15,8 @@ annotation class Name(
 )
 
 /**
- * Annotation to describe a [Patch] or [MethodSignature].
- * @param description A description for the [Patch] or [MethodSignature].
+ * Annotation to describe a [Patch] or [MethodFingerprint].
+ * @param description A description for the [Patch] or [MethodFingerprint].
  */
 @Target(AnnotationTarget.CLASS)
 @Retention(AnnotationRetention.RUNTIME)
@@ -27,8 +27,8 @@ annotation class Description(
 
 
 /**
- * Annotation to version a [Patch] or [MethodSignature].
- * @param version The version of a [Patch] or [MethodSignature].
+ * Annotation to version a [Patch] or [MethodFingerprint].
+ * @param version The version of a [Patch] or [MethodFingerprint].
  */
 @Target(AnnotationTarget.CLASS)
 @Retention(AnnotationRetention.RUNTIME)

src/main/kotlin/app/revanced/patcher/data/Data.kt

@@ -0,0 +1,9 @@
+package app.revanced.patcher.data
+
+import app.revanced.patcher.data.impl.BytecodeData
+import app.revanced.patcher.data.impl.ResourceData
+
+/**
+ * Constraint interface for [BytecodeData] and [ResourceData]
+ */
+interface Data

src/main/kotlin/app/revanced/patcher/data/PackageMetadata.kt

@@ -0,0 +1,13 @@
+package app.revanced.patcher.data
+
+import brut.androlib.meta.MetaInfo
+
+/**
+ * Metadata about a package.
+ */
+class PackageMetadata {
+    lateinit var packageName: String
+    lateinit var packageVersion: String
+
+    internal val metaInfo: MetaInfo = MetaInfo()
+}

src/main/kotlin/app/revanced/patcher/data/PatcherData.kt

@@ -1,18 +0,0 @@
-package app.revanced.patcher.data
-
-import app.revanced.patcher.data.base.Data
-import app.revanced.patcher.data.implementation.BytecodeData
-import app.revanced.patcher.data.implementation.ResourceData
-import app.revanced.patcher.patch.base.Patch
-import org.jf.dexlib2.iface.ClassDef
-import java.io.File
-
-internal data class PatcherData(
-    val internalClasses: MutableList<ClassDef>,
-    val resourceCacheDirectory: String
-) {
-    internal val patches = mutableListOf<Class<out Patch<Data>>>()
-
-    internal val bytecodeData = BytecodeData(internalClasses)
-    internal val resourceData = ResourceData(File(resourceCacheDirectory))
-}

src/main/kotlin/app/revanced/patcher/data/base/Data.kt

@@ -1,9 +0,0 @@
-package app.revanced.patcher.data.base
-
-import app.revanced.patcher.data.implementation.BytecodeData
-import app.revanced.patcher.data.implementation.ResourceData
-
-/**
- * Constraint interface for [BytecodeData] and [ResourceData]
- */
-interface Data

src/main/kotlin/app/revanced/patcher/data/impl/BytecodeData.kt

@@ -1,6 +1,6 @@
-package app.revanced.patcher.data.implementation
+package app.revanced.patcher.data.impl
 
-import app.revanced.patcher.data.base.Data
+import app.revanced.patcher.data.Data
 import app.revanced.patcher.util.ProxyBackedClassList
 import app.revanced.patcher.util.method.MethodWalker
 import org.jf.dexlib2.iface.ClassDef
@@ -28,6 +28,15 @@ class BytecodeData(
         classes.proxies.firstOrNull { predicate(it.immutableClass) } ?:
         // else resolve the class to a proxy and return it, if the predicate is matching a class
         classes.find(predicate)?.let { proxy(it) }
+
+    fun proxy(classDef: ClassDef): app.revanced.patcher.util.proxy.ClassProxy {
+        var proxy = this.classes.proxies.find { it.immutableClass.type == classDef.type }
+        if (proxy == null) {
+            proxy = app.revanced.patcher.util.proxy.ClassProxy(classDef)
+            this.classes.add(proxy)
+        }
+        return proxy
+    }
 }
 
 internal class MethodNotFoundException(s: String) : Exception(s)
@@ -57,13 +66,4 @@ internal inline fun <T> Iterable<T>.findIndexed(predicate: (T) -> Boolean): Pair
         }
     }
     return null
-}
-
-fun BytecodeData.proxy(classDef: ClassDef): app.revanced.patcher.util.proxy.ClassProxy {
-    var proxy = this.classes.proxies.find { it.immutableClass.type == classDef.type }
-    if (proxy == null) {
-        proxy = app.revanced.patcher.util.proxy.ClassProxy(classDef)
-        this.classes.add(proxy)
-    }
-    return proxy
 }

src/main/kotlin/app/revanced/patcher/data/impl/ResourceData.kt

@@ -0,0 +1,49 @@
+package app.revanced.patcher.data.impl
+
+import app.revanced.patcher.data.Data
+import org.w3c.dom.Document
+import java.io.Closeable
+import java.io.File
+import java.io.InputStream
+import java.io.OutputStream
+import javax.xml.parsers.DocumentBuilderFactory
+import javax.xml.transform.TransformerFactory
+import javax.xml.transform.dom.DOMSource
+import javax.xml.transform.stream.StreamResult
+
+class ResourceData(private val resourceCacheDirectory: File) : Data, Iterable<File> {
+    val xmlEditor = XmlFileHolder()
+
+    operator fun get(path: String) = resourceCacheDirectory.resolve(path)
+
+    override fun iterator() = resourceCacheDirectory.walkTopDown().iterator()
+
+    inner class XmlFileHolder {
+        operator fun get(inputStream: InputStream, outputStream: OutputStream) =
+            DomFileEditor(inputStream, lazyOf(outputStream))
+
+        operator fun get(path: String) = DomFileEditor(this@ResourceData[path])
+    }
+}
+
+class DomFileEditor internal constructor(
+    private val inputStream: InputStream,
+    private val outputStream: Lazy<OutputStream>,
+) : Closeable {
+    val file: Document = DocumentBuilderFactory.newInstance().newDocumentBuilder().parse(inputStream)
+        .also(Document::normalize)
+
+    // lazily open an output stream
+    // this is required because when constructing a DomFileEditor the output stream is created along with the input stream, which is not allowed
+    // the workaround is to lazily create the output stream. This way it would be used after the input stream is closed, which happens in the constructor
+    constructor(file: File) : this(file.inputStream(), lazy { file.outputStream() })
+
+    override fun close() {
+        val result = StreamResult(outputStream.value)
+        TransformerFactory.newInstance().newTransformer().transform(DOMSource(file), result)
+
+        inputStream.close()
+        outputStream.value.close()
+    }
+
+}

src/main/kotlin/app/revanced/patcher/data/implementation/ResourceData.kt

@@ -1,48 +0,0 @@
-package app.revanced.patcher.data.implementation
-
-import app.revanced.patcher.data.base.Data
-import org.w3c.dom.Document
-import java.io.Closeable
-import java.io.File
-import javax.xml.XMLConstants
-import javax.xml.parsers.DocumentBuilderFactory
-import javax.xml.transform.TransformerFactory
-import javax.xml.transform.dom.DOMSource
-import javax.xml.transform.stream.StreamResult
-
-class ResourceData(private val resourceCacheDirectory: File) : Data {
-    private fun resolve(path: String) = resourceCacheDirectory.resolve(path)
-
-    fun forEach(action: (File) -> Unit) = resourceCacheDirectory.walkTopDown().forEach(action)
-    fun get(path: String) = resolve(path)
-
-    fun replace(path: String, oldValue: String, newValue: String, oldValueIsRegex: Boolean = false) {
-        // TODO: buffer this somehow
-        val content = resolve(path).readText()
-
-        if (oldValueIsRegex) {
-            content.replace(Regex(oldValue), newValue)
-            return
-        }
-    }
-
-    fun getXmlEditor(path: String) = DomFileEditor(resolve(path))
-}
-
-class DomFileEditor internal constructor(private val domFile: File) : Closeable {
-    val file: Document
-
-    init {
-        val factory = DocumentBuilderFactory.newInstance()
-        factory.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, true)
-
-        val builder = factory.newDocumentBuilder()
-
-        // this will expectedly throw
-        file = builder.parse(domFile)
-        file.normalize()
-    }
-
-    override fun close() = TransformerFactory.newInstance().newTransformer()
-        .transform(DOMSource(file), StreamResult(domFile.outputStream()))
-}

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

@@ -4,11 +4,9 @@ import app.revanced.patcher.annotation.Compatibility
 import app.revanced.patcher.annotation.Description
 import app.revanced.patcher.annotation.Name
 import app.revanced.patcher.annotation.Version
-import app.revanced.patcher.data.base.Data
-import app.revanced.patcher.patch.base.Patch
-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.data.Data
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import app.revanced.patcher.patch.Patch
 import kotlin.reflect.KClass
 
 /**
@@ -41,17 +39,19 @@ object PatchExtensions {
     val Class<out Patch<Data>>.patchName: String
         get() = recursiveAnnotation(Name::class)?.name ?: this.javaClass.simpleName
     val Class<out Patch<Data>>.version get() = recursiveAnnotation(Version::class)?.version
+    val Class<out Patch<Data>>.include get() = recursiveAnnotation(app.revanced.patcher.patch.annotations.Patch::class)!!.include
     val Class<out Patch<Data>>.description get() = recursiveAnnotation(Description::class)?.description
     val Class<out Patch<Data>>.dependencies get() = recursiveAnnotation(app.revanced.patcher.patch.annotations.Dependencies::class)?.dependencies
     val Class<out Patch<Data>>.compatiblePackages get() = recursiveAnnotation(Compatibility::class)?.compatiblePackages
 }
 
-object MethodSignatureExtensions {
-    val MethodSignature.name: String get() = javaClass.recursiveAnnotation(Name::class)?.name ?: this.javaClass.simpleName
-    val MethodSignature.version get() = javaClass.recursiveAnnotation(Version::class)?.version ?: "0.0.1"
-    val MethodSignature.description get() = javaClass.recursiveAnnotation(Description::class)?.description
-    val MethodSignature.compatiblePackages get() = javaClass.recursiveAnnotation(Compatibility::class)?.compatiblePackages
-    val MethodSignature.matchingMethod get() = javaClass.recursiveAnnotation(MatchingMethod::class)
-    val MethodSignature.fuzzyPatternScanMethod get() = javaClass.recursiveAnnotation(FuzzyPatternScanMethod::class)
-    val MethodSignature.fuzzyThreshold get() = fuzzyPatternScanMethod?.threshold ?: 0
+object MethodFingerprintExtensions {
+    val MethodFingerprint.name: String
+        get() = javaClass.recursiveAnnotation(Name::class)?.name ?: this.javaClass.simpleName
+    val MethodFingerprint.version get() = javaClass.recursiveAnnotation(Version::class)?.version ?: "0.0.1"
+    val MethodFingerprint.description get() = javaClass.recursiveAnnotation(Description::class)?.description
+    val MethodFingerprint.compatiblePackages get() = javaClass.recursiveAnnotation(Compatibility::class)?.compatiblePackages
+    val MethodFingerprint.matchingMethod get() = javaClass.recursiveAnnotation(app.revanced.patcher.fingerprint.method.annotation.MatchingMethod::class)
+    val MethodFingerprint.fuzzyPatternScanMethod get() = javaClass.recursiveAnnotation(app.revanced.patcher.fingerprint.method.annotation.FuzzyPatternScanMethod::class)
+    val MethodFingerprint.fuzzyScanThreshold get() = fuzzyPatternScanMethod?.threshold ?: 0
 }

src/main/kotlin/app/revanced/patcher/fingerprint/Fingerprint.kt

@@ -0,0 +1,9 @@
+package app.revanced.patcher.fingerprint
+
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+
+/**
+ * A ReVanced fingerprint.
+ * Can be a [MethodFingerprint].
+ */
+interface Fingerprint

src/main/kotlin/app/revanced/patcher/fingerprint/method/annotation/MethodFingerprintMetadata.kt

@@ -1,11 +1,11 @@
-package app.revanced.patcher.signature.implementation.method.annotation
+package app.revanced.patcher.fingerprint.method.annotation
 
-import app.revanced.patcher.signature.implementation.method.MethodSignature
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
 
 /**
- * Annotations for a method which matches to a [MethodSignature].
+ * Annotations for a method which matches to a [MethodFingerprint].
  * @param definingClass The defining class name of the method.
- * @param name A suggestive name for the method which the [MethodSignature] was created for.
+ * @param name A suggestive name for the method which the [MethodFingerprint] was created for.
  */
 @Target(AnnotationTarget.CLASS)
 @Retention(AnnotationRetention.RUNTIME)
@@ -15,7 +15,7 @@ annotation class MatchingMethod(
 )
 
 /**
- * Annotations to scan a pattern [MethodSignature] with fuzzy algorithm.
+ * Annotations to scan a pattern [MethodFingerprint] with fuzzy algorithm.
  * @param threshold if [threshold] or more of the opcodes do not match, skip.
  */
 @Target(AnnotationTarget.CLASS)
@@ -25,7 +25,7 @@ annotation class FuzzyPatternScanMethod(
 )
 
 /**
- * Annotations to scan a pattern [MethodSignature] directly.
+ * Annotations to scan a pattern [MethodFingerprint] directly.
  */
 @Target(AnnotationTarget.CLASS)
 @Retention(AnnotationRetention.RUNTIME)

src/main/kotlin/app/revanced/patcher/fingerprint/method/impl/MethodFingerprint.kt

@@ -0,0 +1,98 @@
+package app.revanced.patcher.fingerprint.method.impl
+
+import app.revanced.patcher.data.impl.BytecodeData
+import app.revanced.patcher.data.impl.MethodNotFoundException
+import app.revanced.patcher.extensions.MethodFingerprintExtensions.name
+import app.revanced.patcher.extensions.softCompareTo
+import app.revanced.patcher.fingerprint.Fingerprint
+import app.revanced.patcher.fingerprint.method.utils.MethodFingerprintUtils
+import app.revanced.patcher.util.proxy.ClassProxy
+import org.jf.dexlib2.Opcode
+import org.jf.dexlib2.iface.ClassDef
+import org.jf.dexlib2.iface.Method
+
+/**
+ * Represents the [MethodFingerprint] for a method.
+ * @param returnType The return type of the method.
+ * @param access The access flags of the method.
+ * @param parameters The parameters of the method.
+ * @param opcodes The list of opcodes of the method.
+ * @param strings A list of strings which a method contains.
+ * @param customFingerprint A custom condition for this fingerprint.
+ * A `null` opcode is equals to an unknown opcode.
+ */
+abstract class MethodFingerprint(
+    internal val returnType: String?,
+    internal val access: Int?,
+    internal val parameters: Iterable<String>?,
+    internal val opcodes: Iterable<Opcode?>?,
+    internal val strings: Iterable<String>? = null,
+    internal val customFingerprint: ((methodDef: Method) -> Boolean)? = null
+) : Fingerprint {
+    /**
+     * The result of the [MethodFingerprint] the [Method].
+     * @throws MethodNotFoundException If the resolution of the [Method] has not happened.
+     */
+    var result: MethodFingerprintResult? = null
+        get() = field ?: throw Exception("${this.name} has not been resolved yet.")
+}
+
+/**
+ * Represents the result of a [MethodFingerprintUtils].
+ * @param method The matching method.
+ * @param classDef The [ClassDef] that contains the matching [method].
+ * @param patternScanResult Opcodes pattern scan result.
+ * @param data The [BytecodeData] this [MethodFingerprintResult] is attached to, to create proxies.
+ */
+data class MethodFingerprintResult(
+    val method: Method,
+    val classDef: ClassDef,
+    val patternScanResult: PatternScanResult?,
+    internal val data: BytecodeData
+) {
+    /**
+     * Returns a mutable clone of [classDef]
+     *
+     * Please note, this method allocates a [ClassProxy].
+     * Use [classDef] where possible.
+     */
+    val mutableClass by lazy { data.proxy(classDef).resolve() }
+
+    /**
+     * Returns a mutable clone of [method]
+     *
+     * Please note, this method allocates a [ClassProxy].
+     * Use [method] where possible.
+     */
+    val mutableMethod by lazy {
+        mutableClass.methods.first {
+            it.softCompareTo(this.method)
+        }
+    }
+}
+
+/**
+ * The result of a pattern scan.
+ * @param startIndex The start index of the instructions where to which this pattern matches.
+ * @param endIndex The end index of the instructions where to which this pattern matches.
+ * @param warnings A list of warnings considering this [PatternScanResult].
+ */
+data class PatternScanResult(
+    val startIndex: Int,
+    val endIndex: Int,
+    var warnings: List<Warning>? = null
+) {
+    /**
+     * Represents warnings of the pattern scan.
+     * @param correctOpcode The opcode the instruction list has.
+     * @param wrongOpcode The opcode the pattern list of the signature currently has.
+     * @param instructionIndex The index of the opcode relative to the instruction list.
+     * @param patternIndex The index of the opcode relative to the pattern list from the signature.
+     */
+    data class Warning(
+        val correctOpcode: Opcode,
+        val wrongOpcode: Opcode,
+        val instructionIndex: Int,
+        val patternIndex: Int,
+    )
+}

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

@@ -0,0 +1,158 @@
+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/main/kotlin/app/revanced/patcher/logging/Logger.kt

@@ -0,0 +1,8 @@
+package app.revanced.patcher.logging
+
+interface Logger {
+    fun error(msg: String) {}
+    fun warn(msg: String) {}
+    fun info(msg: String) {}
+    fun trace(msg: String) {}
+}

src/main/kotlin/app/revanced/patcher/logging/impl/NopLogger.kt

@@ -0,0 +1,5 @@
+package app.revanced.patcher.logging.impl
+
+import app.revanced.patcher.logging.Logger
+
+object NopLogger : Logger

src/main/kotlin/app/revanced/patcher/patch/Patch.kt

@@ -0,0 +1,18 @@
+package app.revanced.patcher.patch
+
+import app.revanced.patcher.data.Data
+import app.revanced.patcher.patch.impl.BytecodePatch
+import app.revanced.patcher.patch.impl.ResourcePatch
+
+
+/**
+ * A ReVanced patch.
+ * Can either be a [ResourcePatch] or a [BytecodePatch].
+ */
+abstract class Patch<out T : Data> {
+
+    /**
+     * The main function of the [Patch] which the patcher will call.
+     */
+    abstract fun execute(data: @UnsafeVariance T): PatchResult
+}

src/main/kotlin/app/revanced/patcher/patch/PatchResult.kt

@@ -1,4 +1,4 @@
-package app.revanced.patcher.patch.implementation.misc
+package app.revanced.patcher.patch
 
 interface PatchResult {
     fun error(): PatchResultError? {

src/main/kotlin/app/revanced/patcher/patch/annotations/PatchAnnotation.kt

@@ -1,16 +1,17 @@
 package app.revanced.patcher.patch.annotations
 
-import app.revanced.patcher.data.base.Data
-import app.revanced.patcher.patch.base.Patch
+import app.revanced.patcher.data.Data
+import app.revanced.patcher.patch.Patch
 import kotlin.reflect.KClass
 
 /**
  * Annotation to mark a Class as a patch.
+ * @param include If false, the patch should be treated as optional by default.
  */
 @Target(AnnotationTarget.CLASS)
 @Retention(AnnotationRetention.RUNTIME)
 @MustBeDocumented
-annotation class Patch
+annotation class Patch(val include: Boolean = true)
 
 /**
  * Annotation for dependencies of [Patch]es .