chore(release): 19.3.0 [skip ci]

# [19.3.0](https://github.com/ReVanced/revanced-patcher/compare/v19.2.0...v19.3.0) (2024-02-14)

### Bug Fixes

* Use `Patch#toString` to get patch class name, when no name available ([c9a8260](c9a82608f7))

### Features

* Read and write arbitrary files in APK files ([f1d7217](f1d7217495))

.editorconfig

@@ -0,0 +1,3 @@
+[*.{kt,kts}]
+ktlint_code_style = intellij_idea
+ktlint_standard_no-wildcard-imports = disabled

.github/ISSUE_TEMPLATE/bug-issue.yml

@@ -1,72 +0,0 @@
-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/bug-report.yml

@@ -0,0 +1,108 @@
+name: 🐞 Bug report
+description: Report a bug or an issue.
+title: 'bug: '
+labels: ['Bug report']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        <p align="center">
+          <picture>
+            <source
+              width="256px"
+              media="(prefers-color-scheme: dark)"
+              srcset="https://raw.githubusercontent.com/revanced/revanced-patcher/main/assets/revanced-headline/revanced-headline-vertical-dark.svg"
+            >
+            <img 
+              width="256px"
+              src="https://raw.githubusercontent.com/revanced/revanced-patcher/main/assets/revanced-headline/revanced-headline-vertical-light.svg"
+            >
+          </picture>
+          <br>
+          <a href="https://revanced.app/">
+             <picture>
+                 <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/revanced/revanced-patcher/main/assets/revanced-logo/revanced-logo.svg" />
+                 <img height="24px" src="https://raw.githubusercontent.com/revanced/revanced-patcher/main/assets/revanced-logo/revanced-logo.svg" />
+             </picture>
+           </a>&nbsp;&nbsp;&nbsp;
+           <a href="https://github.com/ReVanced">
+               <picture>
+                   <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://i.ibb.co/dMMmCrW/Git-Hub-Mark.png" />
+                   <img height="24px" src="https://i.ibb.co/9wV3HGF/Git-Hub-Mark-Light.png" />
+               </picture>
+           </a>&nbsp;&nbsp;&nbsp;
+           <a href="http://revanced.app/discord">
+               <picture>
+                   <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
+                   <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
+               </picture>
+           </a>&nbsp;&nbsp;&nbsp;
+           <a href="https://reddit.com/r/revancedapp">
+               <picture>
+                   <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
+                   <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
+               </picture>
+           </a>&nbsp;&nbsp;&nbsp;
+           <a href="https://t.me/app_revanced">
+              <picture>
+                 <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
+                 <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
+              </picture>
+           </a>&nbsp;&nbsp;&nbsp;
+           <a href="https://x.com/revancedapp">
+              <picture>
+                 <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/93124920/270180600-7c1b38bf-889b-4d68-bd5e-b9d86f91421a.png">
+                 <img height="24px" src="https://user-images.githubusercontent.com/93124920/270108715-d80743fa-b330-4809-b1e6-79fbdc60d09c.png" />
+              </picture>
+           </a>&nbsp;&nbsp;&nbsp;
+           <a href="https://www.youtube.com/@ReVanced">
+              <picture>
+                 <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
+                 <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
+             </picture>
+           </a>
+           <br>
+           <br>
+           Continuing the legacy of Vanced
+        </p>
+
+        # ReVanced Patcher bug report
+
+        Before creating a new bug report, please keep the following in mind:
+        
+        - **Do not submit a duplicate bug report**: You can review existing bug reports [here](https://github.com/ReVanced/revanced-patcher/labels/Bug%20report).
+        - **Do not use the issue page for support**: If you need help or have questions, check out other platforms on [revanced.app](https://revanced.app).
+  - type: textarea
+    attributes:
+      label: Bug description
+      description: |
+        - Describe your bug in detail
+        - Add steps to reproduce the bug if possible (Step 1. ... Step 2. ...)
+        - Add images and videos if possible
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Error logs
+      description: Exceptions can be captured by running `logcat | grep AndroidRuntime` in a shell.
+      render: shell
+  - type: textarea
+    attributes:
+      label: Solution
+      description: If applicable, add a possible solution to the bug.
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: Add additional context here.
+  - type: checkboxes
+    id: acknowledgements
+    attributes:
+      label: Acknowledgements
+      description: Your bug report will be closed if you don't follow the checklist below.
+      options:
+        - label: This issue is not a duplicate of an existing bug report.
+          required: true
+        - label: I have chosen an appropriate title.
+          required: true
+        - label: All requested information has been provided properly.
+          required: true

.github/ISSUE_TEMPLATE/feature-issue.yml

@@ -1,58 +0,0 @@
-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/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,106 @@
+name: ⭐ Feature request
+description: Create a detailed request for a new feature.
+title: 'feat: '
+labels: ['Feature request']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        <p align="center">
+          <picture>
+            <source
+              width="256px"
+              media="(prefers-color-scheme: dark)"
+              srcset="https://raw.githubusercontent.com/revanced/revanced-patcher/main/assets/revanced-headline/revanced-headline-vertical-dark.svg"
+            >
+            <img 
+              width="256px"
+              src="https://raw.githubusercontent.com/revanced/revanced-patcher/main/assets/revanced-headline/revanced-headline-vertical-light.svg"
+            >
+          </picture>
+          <br>
+          <a href="https://revanced.app/">
+             <picture>
+                 <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/revanced/revanced-patcher/main/assets/revanced-logo/revanced-logo.svg" />
+                 <img height="24px" src="https://raw.githubusercontent.com/revanced/revanced-patcher/main/assets/revanced-logo/revanced-logo.svg" />
+             </picture>
+           </a>&nbsp;&nbsp;&nbsp;
+           <a href="https://github.com/ReVanced">
+               <picture>
+                   <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://i.ibb.co/dMMmCrW/Git-Hub-Mark.png" />
+                   <img height="24px" src="https://i.ibb.co/9wV3HGF/Git-Hub-Mark-Light.png" />
+               </picture>
+           </a>&nbsp;&nbsp;&nbsp;
+           <a href="http://revanced.app/discord">
+               <picture>
+                   <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
+                   <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
+               </picture>
+           </a>&nbsp;&nbsp;&nbsp;
+           <a href="https://reddit.com/r/revancedapp">
+               <picture>
+                   <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
+                   <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
+               </picture>
+           </a>&nbsp;&nbsp;&nbsp;
+           <a href="https://t.me/app_revanced">
+              <picture>
+                 <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
+                 <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
+              </picture>
+           </a>&nbsp;&nbsp;&nbsp;
+           <a href="https://x.com/revancedapp">
+              <picture>
+                 <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/93124920/270180600-7c1b38bf-889b-4d68-bd5e-b9d86f91421a.png">
+                 <img height="24px" src="https://user-images.githubusercontent.com/93124920/270108715-d80743fa-b330-4809-b1e6-79fbdc60d09c.png" />
+              </picture>
+           </a>&nbsp;&nbsp;&nbsp;
+           <a href="https://www.youtube.com/@ReVanced">
+              <picture>
+                 <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
+                 <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
+             </picture>
+           </a>
+           <br>
+           <br>
+           Continuing the legacy of Vanced
+        </p>
+
+        # ReVanced Patcher feature request
+
+        Before creating a new feature request, please keep the following in mind:
+
+        - **Do not submit a duplicate feature request**: You can review existing feature requests [here](https://github.com/ReVanced/revanced-patcher/labels/Feature%20request).
+        - **Do not use the issue page for support**: If you need help or have questions, check out other platforms on [revanced.app](https://revanced.app).
+
+  - type: textarea
+    attributes:
+      label: Feature description
+      description: |
+        - Describe your feature in detail
+        - Add images, videos, links, examples, references, etc. if possible
+        - Add the target application name in case you request a new patch
+  - type: textarea
+    attributes:
+      label: Motivation
+      description: |
+        A strong motivation is necessary for a feature request to be considered.
+        
+        - Why should this feature be implemented? 
+        - What is the explicit use case?
+        - What are the benefits?
+        - What makes this feature important?
+    validations:
+      required: true
+  - type: checkboxes
+    id: acknowledgements
+    attributes:
+      label: Acknowledgements
+      description: Your feature request will be closed if you don't follow the checklist below.
+      options:
+        - label: This issue is not a duplicate of an existing feature request.
+          required: true
+        - label: I have chosen an appropriate title.
+          required: true
+        - label: All requested information has been provided properly.
+          required: true

.github/config.yml

@@ -1,2 +1,2 @@
 firstPRMergeComment: >
-  Thank you for contributing to ReVanced. Join us on [Discord](https://revanced.app/discord) if you want to receive a contributor role.
+  Thank you for contributing to ReVanced. Join us on [Discord](https://revanced.app/discord) to receive a role for your contribution.

.github/dependabot.yml

@@ -0,0 +1,22 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    labels: []
+    directory: /
+    target-branch: dev
+    schedule:
+      interval: monthly
+
+  - package-ecosystem: npm
+    labels: []
+    directory: /
+    target-branch: dev
+    schedule:
+      interval: monthly
+
+  - package-ecosystem: gradle
+    labels: []
+    directory: /
+    target-branch: dev
+    schedule:
+      interval: monthly

.github/workflows/pull_request.yml

@@ -1,4 +1,4 @@
-name: PR to main
+name: Open a PR to main
 
 on:
   push:
@@ -7,7 +7,7 @@ on:
   workflow_dispatch:
 
 env:
-  MESSAGE: merge branch `${{ github.head_ref || github.ref_name }}` to `main`
+  MESSAGE: Merge branch `${{ github.head_ref || github.ref_name }}` to `main`
 
 jobs:
   pull-request:
@@ -15,7 +15,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+
       - name: Open pull request
         uses: repo-sync/pull-request@v2
         with:

.github/workflows/release.yml

@@ -17,28 +17,37 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         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: Cache
-        uses: actions/cache@v3
+
+      - name: Import GPG key
+        uses: crazy-max/ghaction-import-gpg@v6
         with:
-          path: |
-            ${{ runner.home }}/.gradle/caches
-            ${{ runner.home }}/.gradle/wrapper
-            .gradle
-            build
-            node_modules
-          key: ${{ runner.os }}-gradle-npm-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties', 'package-lock.json') }}
-      - name: Build with Gradle
+          gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
+          passphrase: ${{ secrets.PASSPHRASE }}
+          fingerprint: ${{ env.GPG_FINGERPRINT }}
+
+      - name: Cache Gradle
+        uses: burrunan/gradle-cache-action@v1
+
+      - name: Build
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: ./gradlew clean --no-daemon
-      - name: Setup semantic-release
+        run: ./gradlew build clean
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "lts/*"
+          cache: 'npm'
+
+      - name: Install dependencies
         run: npm install
+
       - name: Release
         env:
           GITHUB_TOKEN: ${{ secrets.REPOSITORY_PUSH_ACCESS }}

build.gradle.kts

@@ -1,54 +1,59 @@
 plugins {
-    kotlin("jvm") version "1.8.20"
+    alias(libs.plugins.kotlin)
+    alias(libs.plugins.binary.compatibility.validator)
     `maven-publish`
+    signing
+    java
 }
 
 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()
-    google()
-    mavenLocal()
-    listOf("multidexlib2", "apktool").forEach { repo ->
-        maven {
-            url = uri("https://maven.pkg.github.com/revanced/$repo")
-            credentials {
-                username = githubUsername
-                password = githubPassword
-            }
-        }
-    }
-}
-
-dependencies {
-    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.1")
-    implementation("xpp3:xpp3:1.1.4c")
-    implementation("com.android.tools.smali:smali:3.0.3")
-    implementation("app.revanced:multidexlib2:3.0.3.r2")
-    implementation("app.revanced:apktool-lib:2.8.2-5")
-    implementation("org.jetbrains.kotlin:kotlin-reflect:1.9.0")
-
-    compileOnly("com.google.android:android:4.1.1.4")
-
-    testImplementation("org.jetbrains.kotlin:kotlin-test:1.8.20-RC")
-}
-
 tasks {
+    processResources {
+        expand("projectVersion" to project.version)
+    }
+
     test {
         useJUnitPlatform()
         testLogging {
             events("PASSED", "SKIPPED", "FAILED")
         }
     }
-    processResources {
-        expand("projectVersion" to project.version)
+}
+
+repositories {
+    mavenCentral()
+    mavenLocal()
+    google()
+    maven {
+        // A repository must be speficied for some reason. "registry" is a dummy.
+        url = uri("https://maven.pkg.github.com/revanced/registry")
+        credentials {
+            username = project.findProperty("gpr.user") as String? ?: System.getenv("GITHUB_ACTOR")
+            password = project.findProperty("gpr.key") as String? ?: System.getenv("GITHUB_TOKEN")
+        }
     }
 }
 
+dependencies {
+    implementation(libs.kotlinx.coroutines.core)
+    implementation(libs.xpp3)
+    implementation(libs.smali)
+    implementation(libs.multidexlib2)
+    implementation(libs.apktool.lib)
+    implementation(libs.kotlin.reflect)
+
+    // TODO: Convert project to KMP.
+    compileOnly(libs.android) {
+        // Exclude, otherwise the org.w3c.dom API breaks.
+        exclude(group = "xerces", module = "xmlParserAPIs")
+    }
+
+    testImplementation(libs.kotlin.test)
+}
+
 java {
+    withJavadocJar()
     withSourcesJar()
 }
 
@@ -57,22 +62,41 @@ kotlin {
 }
 
 publishing {
-    repositories {
-        if (System.getenv("GITHUB_ACTOR") != null)
-            maven {
-                name = "GitHubPackages"
-                url = uri("https://maven.pkg.github.com/revanced/revanced-patcher")
-                credentials {
-                    username = System.getenv("GITHUB_ACTOR")
-                    password = System.getenv("GITHUB_TOKEN")
+    publications {
+        create<MavenPublication>("revanced-patcher-publication") {
+            from(components["java"])
+
+            version = project.version.toString()
+
+            pom {
+                name = "ReVanced Patcher"
+                description = "Patcher used by ReVanced."
+                url = "https://revanced.app"
+
+                licenses {
+                    license {
+                        name = "GNU General Public License v3.0"
+                        url = "https://www.gnu.org/licenses/gpl-3.0.en.html"
+                    }
+                }
+                developers {
+                    developer {
+                        id = "ReVanced"
+                        name = "ReVanced"
+                        email = "contact@revanced.app"
+                    }
+                }
+                scm {
+                    connection = "scm:git:git://github.com/revanced/revanced-patcher.git"
+                    developerConnection = "scm:git:git@github.com:revanced/revanced-patcher.git"
+                    url = "https://github.com/revanced/revanced-patcher"
                 }
             }
-        else
-            mavenLocal()
-    }
-    publications {
-        register<MavenPublication>("gpr") {
-            from(components["java"])
         }
     }
 }
+
+signing {
+    useGpgCmd()
+    sign(publishing.publications["revanced-patcher-publication"])
+}

gradle.properties

@@ -1,4 +1,3 @@
 org.gradle.parallel = true
 org.gradle.caching = true
-kotlin.code.style = official
-version = 14.0.1-dev.1
+version = 19.3.0

gradle/libs.versions.toml

@@ -0,0 +1,23 @@
+[versions]
+android = "4.1.1.4"
+apktool-lib = "2.9.3"
+kotlin = "1.9.22"
+kotlinx-coroutines-core = "1.7.3"
+multidexlib2 = "3.0.3.r3"
+smali = "3.0.4"
+binary-compatibility-validator = "0.13.2"
+xpp3 = "1.1.4c"
+
+[libraries]
+android = { module = "com.google.android:android", version.ref = "android" }
+kotlin-reflect = { module = "org.jetbrains.kotlin:kotlin-reflect", version.ref = "kotlin" }
+apktool-lib = { module = "app.revanced:apktool-lib", version.ref = "apktool-lib" }
+kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin" }
+kotlinx-coroutines-core = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "kotlinx-coroutines-core" }
+multidexlib2 = { module = "app.revanced:multidexlib2", version.ref = "multidexlib2" }
+smali = { module = "com.android.tools.smali:smali", version.ref = "smali" }
+xpp3 = { module = "xpp3:xpp3", version.ref = "xpp3" }
+
+[plugins]
+binary-compatibility-validator = { id = "org.jetbrains.kotlinx.binary-compatibility-validator", version.ref = "binary-compatibility-validator" }
+kotlin = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }

gradle/wrapper/gradle-wrapper.properties

@@ -1,7 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.2-bin.zip
-networkTimeout=10000
-validateDistributionUrl=true
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-bin.zip
+distributionSha256Sum=3e1af3ae886920c3ac87f7a91f816c0c7c436f276a6eefdb3da152100fef72ae
 zipStoreBase=GRADLE_USER_HOME
-zipStorePath=wrapper/dists
+zipStorePath=wrapper/dist

package.json

@@ -1,9 +1,9 @@
 {
   "devDependencies": {
-    "@saithodev/semantic-release-backmerge": "^3.1.0",
-    "@semantic-release/changelog": "^6.0.2",
+    "@saithodev/semantic-release-backmerge": "^4.0.1",
+    "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "gradle-semantic-release-plugin": "^1.7.6",
-    "semantic-release": "^20.1.0"
+    "gradle-semantic-release-plugin": "^1.9.1",
+    "semantic-release": "^23.0.0"
   }
 }

settings.gradle.kts

@@ -1 +1,7 @@
 rootProject.name = "revanced-patcher"
+
+buildCache {
+    local {
+        isEnabled = "CI" !in System.getenv()
+    }
+}

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

@@ -4,5 +4,8 @@ import java.io.File
 
 @FunctionalInterface
 interface IntegrationsConsumer {
+    fun acceptIntegrations(integrations: Set<File>)
+
+    @Deprecated("Use acceptIntegrations(Set<File>) instead.")
     fun acceptIntegrations(integrations: List<File>)
-}
+}

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

@@ -0,0 +1,7 @@
+package app.revanced.patcher
+
+@RequiresOptIn(
+    level = RequiresOptIn.Level.ERROR,
+    message = "This is an internal API, don't rely on it.",
+)
+annotation class InternalApi

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

@@ -4,6 +4,8 @@ import brut.androlib.apk.ApkInfo
 
 /**
  * Metadata about a package.
+ *
+ * @param apkInfo The [ApkInfo] of the apk file.
  */
 class PackageMetadata internal constructor(internal val apkInfo: ApkInfo) {
     lateinit var packageName: String

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

@@ -2,33 +2,96 @@
 
 package app.revanced.patcher
 
-import app.revanced.patcher.extensions.AnnotationExtensions.findAnnotationRecursively
 import app.revanced.patcher.patch.Patch
-import app.revanced.patcher.patch.PatchClass
 import dalvik.system.DexClassLoader
 import lanchon.multidexlib2.BasicDexFileNamer
 import lanchon.multidexlib2.MultiDexIO
 import java.io.File
 import java.net.URLClassLoader
 import java.util.jar.JarFile
+import java.util.logging.Logger
+import kotlin.reflect.KClass
+
 
 /**
- * A patch bundle.
+ * A set of [Patch]es.
+ */
+typealias PatchSet = Set<Patch<*>>
+
+/**
+ * A [Patch] class.
+ */
+typealias PatchClass = KClass<out Patch<*>>
+
+/**
+ * A loader of [Patch]es from patch bundles.
+ * This will load all [Patch]es from the given patch bundles that have a name.
  *
- * @param fromClasses The classes to get [Patch]es from.
+ * @param getBinaryClassNames A function that returns the binary names of all classes in a patch bundle.
+ * @param classLoader The [ClassLoader] to use for loading the classes.
+ * @param patchBundles A set of patches to initialize this instance with.
  */
 sealed class PatchBundleLoader private constructor(
-    fromClasses: Iterable<Class<*>>
-) : MutableList<PatchClass> by mutableListOf() {
-    init {
-        fromClasses.filter {
-            if (it.isAnnotation) return@filter false
+    classLoader: ClassLoader,
+    patchBundles: Array<out File>,
+    getBinaryClassNames: (patchBundle: File) -> List<String>,
+    // This constructor parameter is unfortunately necessary,
+    // so that a reference to the mutable set is present in the constructor to be able to add patches to it.
+    // because the instance itself is a PatchSet, which is immutable, that is delegated by the parameter.
+    private val patchSet: MutableSet<Patch<*>> = mutableSetOf(),
+) : PatchSet by patchSet {
+    private val logger = Logger.getLogger(PatchBundleLoader::class.java.name)
 
-            it.findAnnotationRecursively(app.revanced.patcher.patch.annotations.Patch::class) != null
-        }.map {
-            @Suppress("UNCHECKED_CAST")
-            it as PatchClass
-        }.let { addAll(it) }
+    init {
+        patchBundles.flatMap(getBinaryClassNames).asSequence().map {
+            classLoader.loadClass(it)
+        }.filter {
+            Patch::class.java.isAssignableFrom(it)
+        }.mapNotNull { patchClass ->
+            patchClass.getInstance(logger, silent = true)
+        }.filter {
+            it.name != null
+        }.let { patches ->
+            patchSet.addAll(patches)
+        }
+    }
+
+    internal companion object Utils {
+        /**
+         * Instantiates a [Patch]. If the class is a singleton, the INSTANCE field will be used.
+         *
+         * @param logger The [Logger] to use for logging.
+         * @param silent Whether to suppress logging.
+         * @return The instantiated [Patch] or `null` if the [Patch] could not be instantiated.
+         */
+        internal fun Class<*>.getInstance(
+            logger: Logger,
+            silent: Boolean = false,
+        ): Patch<*>? {
+            return try {
+                getField("INSTANCE").get(null)
+            } catch (exception: NoSuchFieldException) {
+                if (!silent) {
+                    logger.fine(
+                        "Patch class '$name' has no INSTANCE field, therefor not a singleton. " +
+                                "Attempting to instantiate it.",
+                    )
+                }
+
+                try {
+                    getDeclaredConstructor().newInstance()
+                } catch (exception: Exception) {
+                    if (!silent) {
+                        logger.severe(
+                            "Patch class '$name' is not singleton and has no suitable constructor, " +
+                                    "therefor cannot be instantiated and is ignored.",
+                        )
+                    }
+
+                    return null
+                }
+            } as Patch<*>
+        }
     }
 
     /**
@@ -36,36 +99,38 @@ sealed class PatchBundleLoader private constructor(
      *
      * @param patchBundles The path to patch bundles of JAR format.
      */
-    class Jar(vararg patchBundles: File) :
-        PatchBundleLoader(with(URLClassLoader(patchBundles.map { it.toURI().toURL() }.toTypedArray())) {
-            patchBundles.flatMap { patchBundle ->
-                // Get the names of all classes in the DEX file.
-
-                JarFile(patchBundle).entries().asSequence()
-                    .filter { it.name.endsWith(".class") }
-                    .map { it.name.replace('/', '.').replace(".class", "") }
-                    .map { loadClass(it) }
-            }
-        })
+    class Jar(vararg patchBundles: File) : PatchBundleLoader(
+        URLClassLoader(patchBundles.map { it.toURI().toURL() }.toTypedArray()),
+        patchBundles,
+        { patchBundle ->
+            JarFile(patchBundle).entries().toList().filter { it.name.endsWith(".class") }
+                .map { it.name.replace('/', '.').replace(".class", "") }
+        },
+    )
 
     /**
      * A [PatchBundleLoader] for [Dex] files.
      *
      * @param patchBundles The path to patch bundles of DEX format.
+     * @param optimizedDexDirectory The directory to store optimized DEX files in.
+     * This parameter is deprecated and has no effect since API level 26.
      */
-    class Dex(vararg patchBundles: File) : PatchBundleLoader(with(
+    class Dex(vararg patchBundles: File, optimizedDexDirectory: File? = null) : PatchBundleLoader(
         DexClassLoader(
             patchBundles.joinToString(File.pathSeparator) { it.absolutePath },
+            optimizedDexDirectory?.absolutePath,
             null,
-            null,
-            PatchBundleLoader::class.java.classLoader
-        )
+            PatchBundleLoader::class.java.classLoader,
+        ),
+        patchBundles,
+        { patchBundle ->
+            MultiDexIO.readDexFile(true, patchBundle, BasicDexFileNamer(), null, null).classes
+                .map { classDef ->
+                    classDef.type.substring(1, classDef.length - 1)
+                }
+        },
     ) {
-        patchBundles
-            .flatMap {
-                MultiDexIO.readDexFile(true, it, BasicDexFileNamer(), null, null).classes
-            }
-            .map { classDef -> classDef.type.substring(1, classDef.length - 1) }
-            .map { loadClass(it) }
-    })
-}
+        @Deprecated("This constructor is deprecated. Use the constructor with the second parameter instead.")
+        constructor(vararg patchBundles: File) : this(*patchBundles, optimizedDexDirectory = null)
+    }
+}

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

@@ -5,4 +5,4 @@ import kotlinx.coroutines.flow.Flow
 import java.util.function.Function
 
 @FunctionalInterface
-interface PatchExecutorFunction : Function<Boolean, Flow<PatchResult>>
+interface PatchExecutorFunction : Function<Boolean, Flow<PatchResult>>

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

@@ -0,0 +1,72 @@
+package app.revanced.patcher
+
+import app.revanced.patcher.data.ResourceContext
+import brut.androlib.Config
+import java.io.File
+import java.util.logging.Logger
+
+/**
+ * The configuration for the patcher.
+ *
+ * @param apkFile The apk file to patch.
+ * @param temporaryFilesPath A path to a folder to store temporary files in.
+ * @param aaptBinaryPath A path to a custom aapt binary.
+ * @param frameworkFileDirectory A path to the directory to cache the framework file in.
+ * @param multithreadingDexFileWriter Whether to use multiple threads for writing dex files.
+ * This has impact on memory usage and performance.
+ */
+class PatcherConfig(
+    internal val apkFile: File,
+    private val temporaryFilesPath: File = File("revanced-temporary-files"),
+    aaptBinaryPath: String? = null,
+    frameworkFileDirectory: String? = null,
+    internal val multithreadingDexFileWriter: Boolean = false,
+) {
+    private val logger = Logger.getLogger(PatcherConfig::class.java.name)
+
+    /**
+     * The mode to use for resource decoding and compiling.
+     *
+     * @see ResourceContext.ResourceMode
+     */
+    internal var resourceMode = ResourceContext.ResourceMode.NONE
+
+    /**
+     * The configuration for decoding and compiling resources.
+     */
+    internal val resourceConfig =
+        Config.getDefaultConfig().apply {
+            useAapt2 = true
+            aaptPath = aaptBinaryPath ?: ""
+            frameworkDirectory = frameworkFileDirectory
+        }
+
+    /**
+     * The path to the temporary apk files directory.
+     */
+    internal val apkFiles = temporaryFilesPath.resolve("apk")
+
+    /**
+     * The path to the temporary patched files directory.
+     */
+    internal val patchedFiles = temporaryFilesPath.resolve("patched")
+
+    /**
+     * Initialize the temporary files' directories.
+     * This will delete the existing temporary files directory if it exists.
+     */
+    internal fun initializeTemporaryFilesDirectories() {
+        temporaryFilesPath.apply {
+            if (exists()) {
+                logger.info("Deleting existing temporary files directory")
+
+                if (!deleteRecursively()) {
+                    logger.severe("Failed to delete existing temporary files directory")
+                }
+            }
+        }
+
+        apkFiles.mkdirs()
+        patchedFiles.mkdirs()
+    }
+}

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

@@ -3,35 +3,38 @@ package app.revanced.patcher
 import app.revanced.patcher.data.BytecodeContext
 import app.revanced.patcher.data.ResourceContext
 import app.revanced.patcher.patch.Patch
-import app.revanced.patcher.patch.PatchClass
 import brut.androlib.apk.ApkInfo
 import brut.directory.ExtFile
 
 /**
- * A context for ReVanced [Patcher].
+ * A context for the patcher containing the current state of the patcher.
  *
- * @param options The [PatcherOptions] used to create this context.
+ * @param config The configuration for the patcher.
  */
-class PatcherContext internal constructor(options: PatcherOptions) {
+@Suppress("MemberVisibilityCanBePrivate")
+class PatcherContext internal constructor(config: PatcherConfig) {
     /**
-     * [PackageMetadata] of the supplied [PatcherOptions.inputFile].
+     * [PackageMetadata] of the supplied [PatcherConfig.apkFile].
      */
-    val packageMetadata = PackageMetadata(ApkInfo(ExtFile(options.inputFile)))
+    val packageMetadata = PackageMetadata(ApkInfo(ExtFile(config.apkFile)))
 
     /**
-     * The list of [Patch]es to execute.
+     * The map of [Patch]es associated by their [PatchClass].
      */
-    internal val patches = mutableListOf<PatchClass>()
+    internal val executablePatches = mutableMapOf<PatchClass, Patch<*>>()
 
     /**
-     * The [ResourceContext] of this [PatcherContext].
-     * This holds the current state of the resources.
+     * The map of all [Patch]es and their dependencies associated by their [PatchClass].
      */
-    internal val resourceContext = ResourceContext(this, options)
+    internal val allPatches = mutableMapOf<PatchClass, Patch<*>>()
 
     /**
-     * The [BytecodeContext] of this [PatcherContext].
-     * This holds the current state of the bytecode.
+     * A context for the patcher containing the current state of the resources.
      */
-    internal val bytecodeContext = BytecodeContext(options)
-}
+    internal val resourceContext = ResourceContext(packageMetadata, config)
+
+    /**
+     * A context for the patcher containing the current state of the bytecode.
+     */
+    internal val bytecodeContext = BytecodeContext(config)
+}

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

@@ -0,0 +1,15 @@
+package app.revanced.patcher
+
+/**
+ * An exception thrown by ReVanced [Patcher].
+ *
+ * @param errorMessage The exception message.
+ * @param cause The corresponding [Throwable].
+ */
+sealed class PatcherException(errorMessage: String?, cause: Throwable?) : Exception(errorMessage, cause) {
+    constructor(errorMessage: String) : this(errorMessage, null)
+
+    class CircularDependencyException internal constructor(dependant: String) : PatcherException(
+        "Patch '$dependant' causes a circular dependency",
+    )
+}

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

@@ -1,49 +1,25 @@
 package app.revanced.patcher
 
-import app.revanced.patcher.data.ResourceContext
-import app.revanced.patcher.logging.Logger
-import app.revanced.patcher.logging.impl.NopLogger
-import brut.androlib.Config
 import java.io.File
 
-/**
- * Options for ReVanced [Patcher].
- * @param inputFile The input file to patch.
- * @param resourceCachePath The path to the directory to use for caching resources.
- * @param aaptBinaryPath The path to a custom aapt binary.
- * @param frameworkFileDirectory The path to the directory to cache the framework file in.
- * @param logger A [Logger].
- */
+@Deprecated("Use PatcherConfig instead.")
 data class PatcherOptions(
     internal val inputFile: File,
     internal val resourceCachePath: File = File("revanced-resource-cache"),
     internal val aaptBinaryPath: String? = null,
     internal val frameworkFileDirectory: String? = null,
-    internal val logger: Logger = NopLogger
+    internal val multithreadingDexFileWriter: Boolean = false,
 ) {
-    /**
-     * The mode to use for resource decoding.
-     * @see ResourceContext.ResourceDecodingMode
-     */
-    internal var resourceDecodingMode = ResourceContext.ResourceDecodingMode.MANIFEST_ONLY
+    @Deprecated("This method will be removed in the future.")
+    fun recreateResourceCacheDirectory(): File {
+        PatcherConfig(
+            inputFile,
+            resourceCachePath,
+            aaptBinaryPath,
+            frameworkFileDirectory,
+            multithreadingDexFileWriter,
+        ).initializeTemporaryFilesDirectories()
 
-    /**
-     * The configuration to use for resource decoding and compiling.
-     */
-    internal val resourceConfig = Config.getDefaultConfig().apply {
-        useAapt2 = true
-        aaptPath = aaptBinaryPath ?: ""
-        frameworkDirectory = frameworkFileDirectory
-    }
-
-    fun recreateResourceCacheDirectory() = resourceCachePath.also {
-        if (it.exists()) {
-            logger.info("Deleting existing resource cache directory")
-
-            if (!it.deleteRecursively())
-                logger.error("Failed to delete existing resource cache directory")
-        }
-
-        it.mkdirs()
+        return resourceCachePath
     }
 }

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

@@ -2,22 +2,124 @@ package app.revanced.patcher
 
 import java.io.File
 import java.io.InputStream
+import kotlin.jvm.internal.Intrinsics
 
 /**
  * The result of a patcher.
+ *
  * @param dexFiles The patched dex files.
- * @param resourceFile File containing resources that need to be extracted into the APK.
- * @param doNotCompress List of relative paths of files to exclude from compressing.
+ * @param resources The patched resources.
  */
-data class PatcherResult(
-    val dexFiles: List<PatchedDexFile>,
-    val resourceFile: File?,
-    val doNotCompress: List<String>? = null
+@Suppress("MemberVisibilityCanBePrivate")
+class PatcherResult internal constructor(
+    val dexFiles: Set<PatchedDexFile>,
+    val resources: PatchedResources?,
 ) {
+    @Deprecated("This method is not used anymore")
+    constructor(
+        dexFiles: List<PatchedDexFile>,
+        resourceFile: File?,
+        doNotCompress: List<String>? = null,
+    ) : this(dexFiles.toSet(), PatchedResources(resourceFile, null, doNotCompress?.toSet() ?: emptySet(), emptySet()))
+
+    @Deprecated("This method is not used anymore")
+    fun component1(): List<PatchedDexFile> {
+        return dexFiles.toList()
+    }
+
+    @Deprecated("This method is not used anymore")
+    fun component2(): File? {
+        return resources?.resourcesApk
+    }
+
+    @Deprecated("This method is not used anymore")
+    fun component3(): List<String>? {
+        return resources?.doNotCompress?.toList()
+    }
+
+    @Deprecated("This method is not used anymore")
+    fun copy(
+        dexFiles: List<PatchedDexFile>,
+        resourceFile: File?,
+        doNotCompress: List<String>? = null,
+    ): PatcherResult {
+        return PatcherResult(
+            dexFiles.toSet(),
+            PatchedResources(
+                resourceFile,
+                null,
+                doNotCompress?.toSet() ?: emptySet(),
+                emptySet(),
+            ),
+        )
+    }
+
+    @Deprecated("This method is not used anymore")
+    override fun toString(): String {
+        return (("PatcherResult(dexFiles=" + this.dexFiles + ", resourceFile=" + this.resources?.resourcesApk) + ", doNotCompress=" + this.resources?.doNotCompress) + ")"
+    }
+
+    @Deprecated("This method is not used anymore")
+    override fun hashCode(): Int {
+        val result = dexFiles.hashCode()
+        return (
+            (
+                (result * 31) +
+                    (if (this.resources?.resourcesApk == null) 0 else this.resources.resourcesApk.hashCode())
+                ) * 31
+            ) +
+            (if (this.resources?.doNotCompress == null) 0 else this.resources.doNotCompress.hashCode())
+    }
+
+    @Deprecated("This method is not used anymore")
+    override fun equals(other: Any?): Boolean {
+        if (this === other) {
+            return true
+        }
+        if (other is PatcherResult) {
+            return Intrinsics.areEqual(this.dexFiles, other.dexFiles) && Intrinsics.areEqual(
+                this.resources?.resourcesApk,
+                other.resources?.resourcesApk,
+            ) && Intrinsics.areEqual(this.resources?.doNotCompress, other.resources?.doNotCompress)
+        }
+        return false
+    }
+
+    @Suppress("DEPRECATION")
+    @Deprecated("This method is not used anymore")
+    fun getDexFiles() = component1()
+
+    @Suppress("DEPRECATION")
+    @Deprecated("This method is not used anymore")
+    fun getResourceFile() = component2()
+
+    @Suppress("DEPRECATION")
+    @Deprecated("This method is not used anymore")
+    fun getDoNotCompress() = component3()
+
     /**
-     * Wrapper for dex files.
+     * A dex file.
+     *
      * @param name The original name of the dex file.
      * @param stream The dex file as [InputStream].
      */
-    class PatchedDexFile(val name: String, val stream: InputStream)
-}
+    class PatchedDexFile
+    // TODO: Add internal modifier.
+    @Deprecated("This constructor will be removed in the future.")
+    constructor(val name: String, val stream: InputStream)
+
+    /**
+     * The resources of a patched apk.
+     *
+     * @param resourcesApk The compiled resources.apk file.
+     * @param otherResources The directory containing other resources files.
+     * @param doNotCompress List of files that should not be compressed.
+     * @param deleteResources List of predicates about resources that should be deleted.
+     */
+    class PatchedResources internal constructor(
+        val resourcesApk: File?,
+        val otherResources: File?,
+        val doNotCompress: Set<String>,
+        val deleteResources: Set<(String) -> Boolean>,
+    )
+}