chore(release): 6.4.1-dev.1 [skip ci]

## [6.4.1-dev.1](https://github.com/revanced/revanced-patcher/compare/v6.4.0...v6.4.1-dev.1) (2023-01-15)

### Bug Fixes

* update dependency `app.revanced:multidexlib2` ([#150](https://github.com/revanced/revanced-patcher/issues/150)) ([dd7dd38](dd7dd38357))

.github/ISSUE_TEMPLATE/bug-issue.yml

@@ -0,0 +1,72 @@
+name: 🐞 Bug report
+description: Report a very clearly broken issue.
+title: 'bug: <title>'
+labels: [bug]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        # ReVanced bug report
+
+        Important to note that your issue may have already been reported before. Please check for existing issues [here](https://github.com/revanced/revanced-patcher/labels/bug).
+
+  - type: dropdown
+    attributes:
+      label: Type
+      options:
+        - Crash
+        - Cosmetic
+        - Other
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Bug description
+      description: How did you find the bug? Any additional details that might help?
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Steps to reproduce
+      description: Add the steps to reproduce this bug including your environment.
+      placeholder: Step 1. Download some files. Step 2. ...
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Screenshots or videos
+      description: Add screenshots or videos that show the bug here.
+      placeholder: Drag and drop the screenshots/videos into this box.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Solution
+      description: If applicable, add a possible solution.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Additional context
+      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/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 📃 Documentation
+    url: https://github.com/revanced/revanced-documentation/
+    about: Don't know how or where to start? Check out our documentation!
+  - name: 🗨 Discussions
+    url: https://github.com/revanced/revanced-suggestions/discussions
+    about: Got something you think should change or be added? Search for or start a new discussion!

.github/ISSUE_TEMPLATE/feature-issue.yml

@@ -0,0 +1,58 @@
+name: ⭐ Feature request
+description: Create a detailed feature request.
+title: 'feat: <title>'
+labels: [feature-request]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        # ReVanced feature request
+        
+        Do not submit requests for patches here. Please submit them [here](https://github.com/orgs/revanced/discussions/categories/patches) instead.
+        Important to note that your feature request may have already been made before. Please check for existing feature requests [here](https://github.com/revanced/revanced-patcher/labels/feature-request).
+
+  - type: dropdown
+    attributes:
+      label: Type
+      options:
+        - Functionality
+        - Cosmetic
+        - Other
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Issue
+      description: What is the current problem. Why does it require a feature request?
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Feature
+      description: Describe your feature in detail. How does it solve the issue?
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Motivation
+      description: Why should your feature should be considered?
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Additional context
+      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/workflows/pull_request.yml

@@ -0,0 +1,25 @@
+name: PR to main
+
+on:
+  push:
+    branches:
+      - dev
+  workflow_dispatch:
+
+env:
+  MESSAGE: merge branch `${{ github.head_ref || github.ref_name }}` to `main`
+
+jobs:
+  pull-request:
+    name: Open pull request
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Open pull request
+        uses: repo-sync/pull-request@v2
+        with:
+          destination_branch: 'main'
+          pr_title: 'chore: ${{ env.MESSAGE }}'
+          pr_body: 'This pull request will ${{ env.MESSAGE }}.'
+          pr_draft: true

.github/workflows/release.yml

@@ -1,5 +1,7 @@
 name: Release
+
 on:
+  workflow_dispatch:
   push:
     branches:
       - main
@@ -8,33 +10,32 @@ on:
     branches:
       - main
       - dev
+
 jobs:
   release:
     name: Release
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
+          # Make sure the release step uses its own credentials:
+          # https://github.com/cycjimmy/semantic-release-action#private-packages
+          persist-credentials: false
           fetch-depth: 0
       - name: Setup JDK
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v3
         with:
           java-version: '17'
-          distribution: 'adopt'
+          distribution: 'zulu'
           cache: gradle
       - name: Setup Node.js
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
-          node-version: "lts/*"
-      - name: Make gradlew executable
-        run: chmod +x gradlew
-      - name: Build with Gradle
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: ./gradlew build
+          node-version: "latest"
+          cache: 'npm'
       - name: Setup semantic-release
-        run: npm install -g semantic-release @semantic-release/git @semantic-release/changelog gradle-semantic-release-plugin -D
+        run: npm install semantic-release@19.0.5 @saithodev/semantic-release-backmerge @semantic-release/git @semantic-release/changelog gradle-semantic-release-plugin@1.7.4 -D
       - name: Release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -115,3 +115,6 @@ gradle-app.setting
 
 # Avoid ignoring test resources
 !src/test/resources/*
+
+# Dependency directories
+node_modules/

.idea/.gitignore

@@ -6,3 +6,4 @@
 # Datasource local storage ignored files
 /dataSources/
 /dataSources.local.xml
+/kotlinc.xml

.releaserc

@@ -20,6 +20,18 @@
         ]
       }
     ],
-    "@semantic-release/github"
+    [
+      "@saithodev/semantic-release-backmerge",
+      {
+        branches: [{from: "main", to: "dev"}],
+        clearWorkspace: true
+      }
+    ],
+    [
+        "@semantic-release/github",
+        {
+            successComment: false
+        }
+    ]
   ]
 }

README.md

@@ -1 +1,2 @@
 # Patcher
+Patcher framework used in the ReVanced project.

build.gradle.kts

@@ -1,33 +1,32 @@
 plugins {
-    kotlin("jvm") version "1.6.20"
+    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("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.3-8649b642")
+    implementation("org.apktool:apktool-lib:2.9.0-SNAPSHOT")
 
+    implementation(kotlin("reflect"))
     testImplementation(kotlin("test"))
 }
 
@@ -38,18 +37,18 @@ tasks {
             events("PASSED", "SKIPPED", "FAILED")
         }
     }
+    processResources {
+        expand("projectVersion" to project.version)
+    }
 }
 
 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")
@@ -58,13 +57,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-dev.10
+version = 6.4.1-dev.1

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.2-all.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

package.json

@@ -0,0 +1,8 @@
+{
+  "devDependencies": {
+    "@semantic-release/changelog": "^6.0.2",
+    "@semantic-release/git": "^10.0.1",
+    "gradle-semantic-release-plugin": "^1.7.4",
+    "semantic-release": "^19.0.5"
+  }
+}

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

@@ -0,0 +1,19 @@
+package app.revanced.patcher
+
+import app.revanced.patcher.data.BytecodeContext
+import app.revanced.patcher.data.Context
+import app.revanced.patcher.data.PackageMetadata
+import app.revanced.patcher.data.ResourceContext
+import app.revanced.patcher.patch.Patch
+import org.jf.dexlib2.iface.ClassDef
+import java.io.File
+
+data class PatcherContext(
+    val classes: MutableList<ClassDef>,
+    val resourceCacheDirectory: File,
+) {
+    val packageMetadata = PackageMetadata()
+    internal val patches = mutableListOf<Class<out Patch<Context>>>()
+    internal val bytecodeContext = BytecodeContext(classes)
+    internal val resourceContext = ResourceContext(resourceCacheDirectory)
+}

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

@@ -0,0 +1,21 @@
+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 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,
+    internal val resourceCacheDirectory: String,
+    internal val aaptPath: String? = null,
+    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

@@ -0,0 +1,27 @@
+package app.revanced.patcher.annotation
+
+import app.revanced.patcher.patch.Patch
+
+/**
+ * Annotation to constrain a [Patch] to compatible packages.
+ * @param compatiblePackages A list of packages a [Patch] is compatible with.
+ */
+@Target(AnnotationTarget.CLASS)
+@Retention(AnnotationRetention.RUNTIME)
+@MustBeDocumented
+annotation class Compatibility(
+    val compatiblePackages: Array<Package>,
+)
+
+/**
+ * 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] is compatible with.
+ */
+@Target()
+@Retention(AnnotationRetention.RUNTIME)
+@MustBeDocumented
+annotation class Package(
+    val name: String,
+    val versions: Array<String> = [],
+)

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

@@ -0,0 +1,37 @@
+package app.revanced.patcher.annotation
+
+import app.revanced.patcher.patch.Patch
+
+/**
+ * Annotation to name a [Patch].
+ * @param name A suggestive name for the [Patch].
+ */
+@Target(AnnotationTarget.CLASS)
+@Retention(AnnotationRetention.RUNTIME)
+@MustBeDocumented
+annotation class Name(
+    val name: String,
+)
+
+/**
+ * Annotation to describe a [Patch].
+ * @param description A description for the [Patch].
+ */
+@Target(AnnotationTarget.CLASS)
+@Retention(AnnotationRetention.RUNTIME)
+@MustBeDocumented
+annotation class Description(
+    val description: String,
+)
+
+
+/**
+ * Annotation to version a [Patch].
+ * @param version The version of a [Patch].
+ */
+@Target(AnnotationTarget.CLASS)
+@Retention(AnnotationRetention.RUNTIME)
+@MustBeDocumented
+annotation class Version(
+    val version: String,
+)

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

@@ -0,0 +1,181 @@
+package app.revanced.patcher.data
+
+import app.revanced.patcher.util.ProxyBackedClassList
+import app.revanced.patcher.util.method.MethodWalker
+import org.jf.dexlib2.iface.ClassDef
+import org.jf.dexlib2.iface.Method
+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
+
+/**
+ * A common interface to constrain [Context] to [BytecodeContext] and [ResourceContext].
+ */
+
+sealed interface Context
+
+class BytecodeContext internal constructor(classes: MutableList<ClassDef>) : Context {
+    /**
+     * The list of classes.
+     */
+    val classes = ProxyBackedClassList(classes)
+
+    /**
+     * Find a class by a given class name.
+     *
+     * @param className The name of the class.
+     * @return A proxy for the first class that matches the class name.
+     */
+    fun findClass(className: String) = findClass { it.type.contains(className) }
+
+    /**
+     * Find a class by a given predicate.
+     *
+     * @param predicate A predicate to match the class.
+     * @return A proxy for the first class that matches the predicate.
+     */
+    fun findClass(predicate: (ClassDef) -> Boolean) =
+        // if we already proxied the class matching the predicate...
+        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
+    }
+
+    private companion object {
+        inline fun <reified T> Iterable<T>.find(predicate: (T) -> Boolean): T? {
+            for (element in this) {
+                if (predicate(element)) {
+                    return element
+                }
+            }
+            return null
+        }
+    }
+}
+
+/**
+ * Create a [MethodWalker] instance for the current [BytecodeContext].
+ *
+ * @param startMethod The method to start at.
+ * @return A [MethodWalker] instance.
+ */
+fun BytecodeContext.toMethodWalker(startMethod: Method): MethodWalker {
+    return MethodWalker(this, startMethod)
+}
+
+internal inline fun <T> Iterable<T>.findIndexed(predicate: (T) -> Boolean): Pair<T, Int>? {
+    for ((index, element) in this.withIndex()) {
+        if (predicate(element)) {
+            return element to index
+        }
+    }
+    return null
+}
+
+class ResourceContext internal constructor(private val resourceCacheDirectory: File) : Context, 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) =
+            DomFileEditor(inputStream)
+
+        operator fun get(path: String): DomFileEditor {
+            return DomFileEditor(this@ResourceContext[path])
+        }
+
+    }
+}
+
+/**
+ * Wrapper for a file that can be edited as a dom document.
+ *
+ * This constructor does not check for locks to the file when writing.
+ * Use the secondary constructor.
+ *
+ * @param inputStream the input stream to read the xml file from.
+ * @param outputStream the output stream to write the xml file to. If null, the file will be read only.
+ *
+ */
+class DomFileEditor internal constructor(
+    private val inputStream: InputStream,
+    private val outputStream: Lazy<OutputStream>? = null,
+) : Closeable {
+    // path to the xml file to unlock the resource when closing the editor
+    private var filePath: String? = null
+    private var closed: Boolean = false
+
+    /**
+     * The document of the xml file
+     */
+    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() }) {
+        // increase the lock
+        locks.merge(file.path, 1, Integer::sum)
+        filePath = file.path
+    }
+
+    /**
+     * Closes the editor. Write backs and decreases the lock count.
+     *
+     * Will not write back to the file if the file is still locked.
+     */
+    override fun close() {
+        if (closed) return
+
+        inputStream.close()
+
+        // if the output stream is not null, do not close it
+        outputStream?.let {
+            // prevent writing to same file, if it is being locked
+            // isLocked will be false if the editor was created through a stream
+            val isLocked = filePath?.let { path ->
+                val isLocked = locks[path]!! > 1
+                // decrease the lock count if the editor was opened for a file
+                locks.merge(path, -1, Integer::sum)
+                isLocked
+            } ?: false
+
+            // if unlocked, write back to the file
+            if (!isLocked) {
+                it.value.use { stream ->
+                    val result = StreamResult(stream)
+                    TransformerFactory.newInstance().newTransformer().transform(DOMSource(file), result)
+                }
+
+                it.value.close()
+                return
+            }
+        }
+
+        closed = true
+    }
+
+    private companion object {
+        // map of concurrent open files
+        val locks = mutableMapOf<String, Int>()
+    }
+}

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<Patch<Data>>()
-
-    internal val bytecodeData = BytecodeData(patches, 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/implementation/BytecodeData.kt

@@ -1,87 +0,0 @@
-package app.revanced.patcher.data.implementation
-
-import app.revanced.patcher.data.base.Data
-import app.revanced.patcher.methodWalker.MethodWalker
-import app.revanced.patcher.patch.base.Patch
-import app.revanced.patcher.patch.implementation.BytecodePatch
-import app.revanced.patcher.proxy.ClassProxy
-import app.revanced.patcher.signature.SignatureResolverResult
-import app.revanced.patcher.util.ProxyBackedClassList
-import org.jf.dexlib2.iface.ClassDef
-import org.jf.dexlib2.iface.Method
-
-class BytecodeData(
-    // FIXME: ugly solution due to design.
-    //  It does not make sense for a BytecodeData instance to have access to the patches
-    private val patches: List<Patch<Data>>,
-    internalClasses: MutableList<ClassDef>
-) : Data {
-    val classes = ProxyBackedClassList(internalClasses)
-
-    /**
-     * Find a class by a given class name
-     * @return A proxy for the first class that matches the class name
-     */
-    fun findClass(className: String) = findClass { it.type.contains(className) }
-
-    /**
-     * Find a class by a given predicate
-     * @return A proxy for the first class that matches the predicate
-     */
-    fun findClass(predicate: (ClassDef) -> Boolean): ClassProxy? {
-        // if we already proxied the class matching the predicate...
-        for (patch in patches) {
-            if (patch !is BytecodePatch) continue
-            for (signature in patch.signatures) {
-                val result = signature.result
-                result ?: continue
-
-                if (predicate(result.definingClassProxy.immutableClass)) return result.definingClassProxy  // ...then return that proxy
-            }
-        }
-        // else resolve the class to a proxy and return it, if the predicate is matching a class
-        return classes.find(predicate)?.let {
-            proxy(it)
-        }
-    }
-}
-
-
-class MethodMap : LinkedHashMap<String, SignatureResolverResult>() {
-    override fun get(key: String): SignatureResolverResult {
-        return super.get(key) ?: throw MethodNotFoundException("Method $key was not found in the method cache")
-    }
-}
-
-internal class MethodNotFoundException(s: String) : Exception(s)
-
-internal inline fun <reified T> Iterable<T>.find(predicate: (T) -> Boolean): T? {
-    for (element in this) {
-        if (predicate(element)) {
-            return element
-        }
-    }
-    return null
-}
-
-fun BytecodeData.toMethodWalker(startMethod: Method): MethodWalker {
-    return MethodWalker(this, startMethod)
-}
-
-internal inline fun <T> Iterable<T>.findIndexed(predicate: (T) -> Boolean): Pair<T, Int>? {
-    for ((index, element) in this.withIndex()) {
-        if (predicate(element)) {
-            return element to index
-        }
-    }
-    return null
-}
-
-fun BytecodeData.proxy(classDef: ClassDef): ClassProxy {
-    var proxy = this.classes.proxies.find { it.immutableClass.type == classDef.type }
-    if (proxy == null) {
-        proxy = ClassProxy(classDef)
-        this.classes.proxies.add(proxy)
-    }
-    return proxy
-}

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

@@ -1,49 +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 reader(path: String) = resolve(path).reader()
-    fun writer(path: String) = resolve(path).writer()
-
-    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

@@ -0,0 +1,79 @@
+package app.revanced.patcher.extensions
+
+import app.revanced.patcher.annotation.*
+import app.revanced.patcher.data.Context
+import app.revanced.patcher.fingerprint.method.annotation.FuzzyPatternScanMethod
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import app.revanced.patcher.patch.OptionsContainer
+import app.revanced.patcher.patch.Patch
+import app.revanced.patcher.patch.PatchOptions
+import app.revanced.patcher.patch.annotations.DependsOn
+import kotlin.reflect.KClass
+import kotlin.reflect.KVisibility
+import kotlin.reflect.full.companionObject
+import kotlin.reflect.full.companionObjectInstance
+
+/**
+ * Recursively find a given annotation on a class.
+ * @param targetAnnotation The annotation to find.
+ * @return The annotation.
+ */
+private fun <T : Annotation> Class<*>.findAnnotationRecursively(targetAnnotation: KClass<T>) =
+    this.findAnnotationRecursively(targetAnnotation.java, mutableSetOf())
+
+
+private fun <T : Annotation> Class<*>.findAnnotationRecursively(
+    targetAnnotation: Class<T>, traversed: MutableSet<Annotation>
+): T? {
+    val found = this.annotations.firstOrNull { it.annotationClass.java.name == targetAnnotation.name }
+
+    @Suppress("UNCHECKED_CAST") if (found != null) return found as T
+
+    for (annotation in this.annotations) {
+        if (traversed.contains(annotation)) continue
+        traversed.add(annotation)
+
+        return (annotation.annotationClass.java.findAnnotationRecursively(targetAnnotation, traversed)) ?: continue
+    }
+
+    return null
+}
+
+object PatchExtensions {
+    val Class<out Patch<Context>>.patchName: String
+        get() = findAnnotationRecursively(Name::class)?.name ?: this.simpleName
+
+    val Class<out Patch<Context>>.version
+        get() = findAnnotationRecursively(Version::class)?.version
+
+    val Class<out Patch<Context>>.include
+        get() = findAnnotationRecursively(app.revanced.patcher.patch.annotations.Patch::class)!!.include
+
+    val Class<out Patch<Context>>.description
+        get() = findAnnotationRecursively(Description::class)?.description
+
+    val Class<out Patch<Context>>.dependencies
+        get() = findAnnotationRecursively(DependsOn::class)?.dependencies
+
+    val Class<out Patch<Context>>.compatiblePackages
+        get() = findAnnotationRecursively(Compatibility::class)?.compatiblePackages
+
+    val Class<out Patch<Context>>.options: PatchOptions?
+        get() = kotlin.companionObject?.let { cl ->
+            if (cl.visibility != KVisibility.PUBLIC) return null
+            kotlin.companionObjectInstance?.let {
+                (it as? OptionsContainer)?.options
+            }
+        }
+}
+
+object MethodFingerprintExtensions {
+    val MethodFingerprint.name: String
+        get() = this.javaClass.simpleName
+
+    val MethodFingerprint.fuzzyPatternScanMethod
+        get() = javaClass.findAnnotationRecursively(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

@@ -0,0 +1,13 @@
+package app.revanced.patcher.fingerprint.method.annotation
+
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+
+/**
+ * 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)
+@Retention(AnnotationRetention.RUNTIME)
+annotation class FuzzyPatternScanMethod(
+    val threshold: Int = 1
+)