refactor: do initial refactoring attempt

BREAKING CHANGE: This removes the previously available `Path` option

.gitattributes

@@ -0,0 +1,9 @@
+#
+# https://help.github.com/articles/dealing-with-line-endings/
+#
+# Linux start script should use lf
+/gradlew        text eol=lf
+
+# These are Windows script files and should use crlf
+*.bat           text eol=crlf
+

.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/config.yml

@@ -0,0 +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.

.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,4 +1,5 @@
 name: Release
+
 on:
   workflow_dispatch:
   push:
@@ -9,34 +10,36 @@ 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
+      - name: Cache
+        uses: actions/cache@v3
         with:
-          java-version: '17'
-          distribution: 'adopt'
-          cache: gradle
-      - name: Setup Node.js
-        uses: actions/setup-node@v2
-        with:
-          node-version: "lts/*"
-      - name: Make gradlew executable
-        run: chmod +x gradlew
+          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
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: ./gradlew build
+        run: ./gradlew clean --no-daemon
       - name: Setup semantic-release
-        run: npm install -g semantic-release @semantic-release/git @semantic-release/changelog gradle-semantic-release-plugin -D
+        run: npm install
       - name: Release
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: npx semantic-release
+          GITHUB_TOKEN: ${{ secrets.REPOSITORY_PUSH_ACCESS }}
+        run: npm exec semantic-release

.gitignore

@@ -74,6 +74,7 @@ cmake-build-*/
 
 # IntelliJ
 out/
+.idea/
 
 # mpeltonen/sbt-idea plugin
 .idea_modules/
@@ -115,3 +116,9 @@ gradle-app.setting
 
 # Avoid ignoring test resources
 !src/test/resources/*
+
+# Dependency directories
+node_modules/
+
+# Gradle props, to avoid sharing the gpr key
+gradle.properties

.idea/.gitignore

@@ -1,8 +0,0 @@
-# Default ignored files
-/shelf/
-/workspace.xml
-# Editor-based HTTP Client requests
-/httpRequests/
-# Datasource local storage ignored files
-/dataSources/
-/dataSources.local.xml

.idea/codeStyles/Project.xml

@@ -1,10 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <code_scheme name="Project" version="173">
-    <JetCodeStyleSettings>
-      <option name="CODE_STYLE_DEFAULTS" value="KOTLIN_OFFICIAL" />
-    </JetCodeStyleSettings>
-    <codeStyleSettings language="kotlin">
-      <option name="CODE_STYLE_DEFAULTS" value="KOTLIN_OFFICIAL" />
-    </codeStyleSettings>
-  </code_scheme>
-</component>

.idea/codeStyles/codeStyleConfig.xml

@@ -1,5 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <state>
-    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
-  </state>
-</component>

.idea/discord.xml

@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="DiscordProjectSettings">
-    <option name="show" value="PROJECT_FILES" />
-    <option name="description" value="" />
-  </component>
-</project>

.idea/git_toolbox_prj.xml

@@ -1,15 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="GitToolBoxProjectSettings">
-    <option name="commitMessageIssueKeyValidationOverride">
-      <BoolValueOverride>
-        <option name="enabled" value="true" />
-      </BoolValueOverride>
-    </option>
-    <option name="commitMessageValidationEnabledOverride">
-      <BoolValueOverride>
-        <option name="enabled" value="true" />
-      </BoolValueOverride>
-    </option>
-  </component>
-</project>

.idea/inspectionProfiles/Project_Default.xml

@@ -1,6 +0,0 @@
-<component name="InspectionProjectProfileManager">
-  <profile version="1.0">
-    <option name="myName" value="Project Default" />
-    <inspection_tool class="UnusedSymbol" enabled="false" level="WARNING" enabled_by_default="false" />
-  </profile>
-</component>

.idea/misc.xml

@@ -1,10 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ExternalStorageConfigurationManager" enabled="true" />
-  <component name="FrameworkDetectionExcludesConfiguration">
-    <file type="web" url="file://$PROJECT_DIR$" />
-  </component>
-  <component name="ProjectRootManager" version="2" languageLevel="JDK_17" default="true" project-jdk-name="azul-17" project-jdk-type="JavaSDK">
-    <output url="file://$PROJECT_DIR$/out" />
-  </component>
-</project>

.idea/vcs.xml

@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="CommitMessageInspectionProfile">
-    <profile version="1.0">
-      <inspection_tool class="CommitFormat" enabled="true" level="WARNING" enabled_by_default="true" />
-      <inspection_tool class="CommitNamingConvention" enabled="true" level="WARNING" enabled_by_default="true" />
-    </profile>
-  </component>
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>

.releaserc

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

README.md

@@ -1 +1,3 @@
-# Patcher
+# 💉 ReVanced Patcher
+
+ReVanced Patcher used to patch Android applications.

arsclib-utils/.gitignore

@@ -0,0 +1,42 @@
+.gradle
+build/
+!gradle/wrapper/gradle-wrapper.jar
+!**/src/main/**/build/
+!**/src/test/**/build/
+
+### IntelliJ IDEA ###
+.idea/modules.xml
+.idea/jarRepositories.xml
+.idea/compiler.xml
+.idea/libraries/
+*.iws
+*.iml
+*.ipr
+out/
+!**/src/main/**/out/
+!**/src/test/**/out/
+
+### Eclipse ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+bin/
+!**/src/main/**/bin/
+!**/src/test/**/bin/
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+
+### VS Code ###
+.vscode/
+
+### Mac OS ###
+.DS_Store

arsclib-utils/build.gradle.kts

@@ -0,0 +1,18 @@
+plugins {
+    kotlin("jvm")
+    `maven-publish`
+}
+
+group = "app.revanced"
+
+dependencies {
+    implementation("io.github.reandroid:ARSCLib:1.1.7")
+}
+
+java {
+    withSourcesJar()
+}
+
+kotlin {
+    jvmToolchain(11)
+}

arsclib-utils/src/main/kotlin/app/revanced/arsc/ApkResourceException.kt

@@ -0,0 +1,72 @@
+package app.revanced.arsc
+
+/**
+ * An exception thrown when there is an error with APK resources.
+ *
+ * @param message The exception message.
+ * @param throwable The corresponding [Throwable].
+ */
+sealed class ApkResourceException(message: String, throwable: Throwable? = null) : Exception(message, throwable) {
+    /**
+     * An exception when locking resources.
+     *
+     * @param message The exception message.
+     * @param throwable The corresponding [Throwable].
+     */
+    class Locked(message: String, throwable: Throwable? = null) : ApkResourceException(message, throwable)
+
+    /**
+     * An exception when writing resources.
+     *
+     * @param message The exception message.
+     * @param throwable The corresponding [Throwable].
+     */
+     class Write(message: String, throwable: Throwable? = null) : ApkResourceException(message, throwable)
+
+    /**
+     * An exception when reading resources.
+     *
+     * @param message The exception message.
+     * @param throwable The corresponding [Throwable].
+     */
+    class Read(message: String, throwable: Throwable? = null) : ApkResourceException(message, throwable)
+    /**
+     * An exception when decoding resources.
+     *
+     * @param message The exception message.
+     * @param throwable The corresponding [Throwable].
+     */
+    class Decode(message: String, throwable: Throwable? = null) : ApkResourceException(message, throwable)
+
+    /**
+     * An exception when encoding resources.
+     *
+     * @param message The exception message.
+     * @param throwable The corresponding [Throwable].
+     */
+    class Encode(message: String, throwable: Throwable? = null) : ApkResourceException(message, throwable)
+
+    /**
+     * An exception thrown when a reference could not be resolved.
+     *
+     * @param reference The invalid reference.
+     * @param throwable The corresponding [Throwable].
+     */
+    class InvalidReference(reference: String, throwable: Throwable? = null) :
+        ApkResourceException("Failed to resolve: $reference", throwable) {
+
+        /**
+         * An exception thrown when a reference could not be resolved.
+         *
+         * @param type The type of the reference.
+         * @param name The name of the reference.
+         * @param throwable The corresponding [Throwable].
+         */
+        constructor(type: String, name: String, throwable: Throwable? = null) : this("@$type/$name", throwable)
+    }
+
+    /**
+     * An exception thrown when the Apk file not have a resource table, but was expected to have one.
+     */
+    class MissingResourceTable : ApkResourceException("Apk does not have a resource table.")
+}

arsclib-utils/src/main/kotlin/app/revanced/arsc/archive/Archive.kt

@@ -0,0 +1,28 @@
+@file:Suppress("MemberVisibilityCanBePrivate")
+
+package app.revanced.arsc.archive
+
+import app.revanced.arsc.resource.ResourceContainer
+import com.reandroid.apk.ApkModule
+import com.reandroid.apk.DexFileInputSource
+import com.reandroid.archive.InputSource
+import java.io.File
+import java.io.Flushable
+
+/**
+ * A class for reading/writing files in an [ApkModule].
+ *
+ * @param module The [ApkModule] to operate on.
+ */
+class Archive(internal val module: ApkModule) : Flushable {
+    val mainPackageResources = ResourceContainer(this, module.tableBlock)
+
+    fun save(output: File) {
+        flush()
+        module.writeApk(output)
+    }
+    fun readDexFiles(): MutableList<DexFileInputSource> = module.listDexFiles()
+    fun write(inputSource: InputSource) = module.apkArchive.add(inputSource) // Overwrites existing files.
+    fun read(name: String): InputSource? = module.apkArchive.getInputSource(name)
+    override fun flush() = mainPackageResources.flush()
+}

arsclib-utils/src/main/kotlin/app/revanced/arsc/logging/Logger.kt

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

arsclib-utils/src/main/kotlin/app/revanced/arsc/resource/Resource.kt

@@ -0,0 +1,166 @@
+package app.revanced.arsc.resource
+
+import app.revanced.arsc.ApkResourceException
+import com.reandroid.arsc.coder.EncodeResult
+import com.reandroid.arsc.coder.ValueDecoder
+import com.reandroid.arsc.value.Entry
+import com.reandroid.arsc.value.ValueType
+import com.reandroid.arsc.value.array.ArrayBag
+import com.reandroid.arsc.value.array.ArrayBagItem
+import com.reandroid.arsc.value.plurals.PluralsBag
+import com.reandroid.arsc.value.plurals.PluralsBagItem
+import com.reandroid.arsc.value.plurals.PluralsQuantity
+import com.reandroid.arsc.value.style.StyleBag
+import com.reandroid.arsc.value.style.StyleBagItem
+
+/**
+ * A resource value.
+ */
+sealed class Resource {
+    internal abstract fun write(entry: Entry, resources: ResourceContainer)
+}
+
+internal val Resource.isComplex get() = when (this) {
+    is Scalar -> false
+    is Complex -> true
+}
+
+/**
+ * A simple resource.
+ */
+open class Scalar internal constructor(private val valueType: ValueType, private val value: Int) : Resource() {
+    protected open fun data(resources: ResourceContainer) = value
+
+    override fun write(entry: Entry, resources: ResourceContainer) {
+        entry.setValueAsRaw(valueType, data(resources))
+    }
+
+    internal open fun toArrayItem(resources: ResourceContainer) = ArrayBagItem.create(valueType, data(resources))
+    internal open fun toStyleItem(resources: ResourceContainer) = StyleBagItem.create(valueType, data(resources))
+}
+
+/**
+ * A marker class for complex resources.
+ */
+sealed class Complex : Resource()
+
+private fun encoded(encodeResult: EncodeResult?) = encodeResult?.let { Scalar(it.valueType, it.value) }
+    ?: throw ApkResourceException.Encode("Failed to encode value")
+
+/**
+ * Encode a color.
+ *
+ * @param hex The hex value of the color.
+ * @return The encoded [Resource].
+ */
+fun color(hex: String) = encoded(ValueDecoder.encodeColor(hex))
+
+/**
+ * Encode a dimension or fraction.
+ *
+ * @param value The dimension value such as 24dp.
+ * @return The encoded [Resource].
+ */
+fun dimension(value: String) = encoded(ValueDecoder.encodeDimensionOrFraction(value))
+
+/**
+ * Encode a boolean resource.
+ *
+ * @param value The boolean.
+ * @return The encoded [Resource].
+ */
+fun boolean(value: Boolean) = Scalar(ValueType.INT_BOOLEAN, if (value) -Int.MAX_VALUE else 0)
+
+/**
+ * Encode a float.
+ *
+ * @param n The number to encode.
+ * @return The encoded [Resource].
+ */
+fun float(n: Float) = Scalar(ValueType.FLOAT, n.toBits())
+
+/**
+ * Create an integer [Resource].
+ *
+ * @param n The number to encode.
+ * @return The integer [Resource].
+ */
+fun integer(n: Int) = Scalar(ValueType.INT_DEC, n)
+
+/**
+ * Create a reference [Resource].
+ *
+ * @param resourceId The target resource.
+ * @return The reference resource.
+ */
+fun reference(resourceId: Int) = Scalar(ValueType.REFERENCE, resourceId)
+
+/**
+ * Resolve and create a reference [Resource].
+ *
+ * @see reference
+ * @param ref The reference string to resolve.
+ * @param resourceTable The resource table to resolve the reference with.
+ * @return The reference resource.
+ */
+fun reference(resourceTable: ResourceTable, ref: String) = reference(resourceTable.resolve(ref))
+
+/**
+ * An array [Resource].
+ *
+ * @param elements The elements of the array.
+ */
+class Array(private val elements: Collection<Scalar>) : Complex() {
+    override fun write(entry: Entry, resources: ResourceContainer) {
+        ArrayBag.create(entry).addAll(elements.map { it.toArrayItem(resources) })
+    }
+}
+
+/**
+ * A style resource.
+ *
+ * @param elements The attributes to override.
+ * @param parent A reference to the parent style.
+ */
+class Style(private val elements: Map<String, Scalar>, private val parent: String? = null) : Complex() {
+    override fun write(entry: Entry, resources: ResourceContainer) {
+        val resTable = resources.resourceTable
+        val style = StyleBag.create(entry)
+        parent?.let {
+            style.parentId = resTable.resolve(parent)
+        }
+
+        style.putAll(
+            elements.asIterable().associate {
+                StyleBag.resolve(resTable.encodeMaterials, it.key) to it.value.toStyleItem(resources)
+            })
+    }
+}
+
+/**
+ * A quantity string [Resource].
+ *
+ * @param elements A map of the quantity to the corresponding string.
+ */
+class Plurals(private val elements: Map<String, String>) : Complex() {
+    override fun write(entry: Entry, resources: ResourceContainer) {
+        val plurals = PluralsBag.create(entry)
+
+        plurals.putAll(elements.asIterable().associate { (k, v) ->
+            PluralsQuantity.value(k) to PluralsBagItem.string(resources.getOrCreateString(v))
+        })
+    }
+}
+
+/**
+ * A string [Resource].
+ *
+ * @param value The string value.
+ */
+class StringResource(val value: String) : Scalar(ValueType.STRING, 0) {
+    private fun tableString(resources: ResourceContainer) = resources.getOrCreateString(value)
+
+    override fun data(resources: ResourceContainer) = tableString(resources).index
+    override fun toArrayItem(resources: ResourceContainer) = ArrayBagItem.string(tableString(resources))
+    override fun toStyleItem(resources: ResourceContainer) = StyleBagItem.string(tableString(resources))
+}

arsclib-utils/src/main/kotlin/app/revanced/arsc/resource/ResourceContainer.kt

@@ -0,0 +1,167 @@
+package app.revanced.arsc.resource
+
+import app.revanced.arsc.ApkResourceException
+import app.revanced.arsc.archive.Archive
+import com.reandroid.apk.xmlencoder.EncodeUtil
+import com.reandroid.arsc.chunk.TableBlock
+import com.reandroid.arsc.chunk.xml.ResXmlDocument
+import com.reandroid.arsc.value.Entry
+import com.reandroid.arsc.value.ResConfig
+import java.io.Closeable
+import java.io.File
+import java.io.Flushable
+
+class ResourceContainer(private val archive: Archive, internal val tableBlock: TableBlock) : Flushable {
+    private val packageBlock = tableBlock.pickOne() // Pick the main package block.
+    internal lateinit var resourceTable: ResourceTable // TODO: Set this.
+
+    private val lockedResourceFileNames = mutableSetOf<String>()
+
+    private fun lock(resourceFile: ResourceFile) {
+        if (resourceFile.name in lockedResourceFileNames) {
+            throw ApkResourceException.Locked("Resource file ${resourceFile.name} is already locked.")
+        }
+
+        lockedResourceFileNames.add(resourceFile.name)
+    }
+
+    private fun unlock(resourceFile: ResourceFile) {
+        lockedResourceFileNames.remove(resourceFile.name)
+    }
+
+
+    fun <T : ResourceFile> openResource(name: String): ResourceFileEditor<T> {
+        val inputSource = archive.read(name)
+            ?: throw ApkResourceException.Read("Resource file $name not found.")
+
+        val resourceFile = when {
+            ResXmlDocument.isResXmlBlock(inputSource.openStream()) -> {
+                val xmlDocument = archive.module
+                    .loadResXmlDocument(inputSource)
+                    .decodeToXml(resourceTable.entryStore, packageBlock.id)
+
+                ResourceFile.XmlResourceFile(name, xmlDocument)
+            }
+
+            else -> {
+                val bytes = inputSource.openStream().use { it.readAllBytes() }
+
+                ResourceFile.BinaryResourceFile(name, bytes)
+            }
+        }
+
+        try {
+            @Suppress("UNCHECKED_CAST")
+            return ResourceFileEditor(resourceFile as T).also {
+                lockedResourceFileNames.add(name)
+            }
+        } catch (e: ClassCastException) {
+            throw ApkResourceException.Decode("Resource file $name is not ${resourceFile::class}.", e)
+        }
+    }
+
+    inner class ResourceFileEditor<T : ResourceFile> internal constructor(
+        private val resourceFile: T,
+    ) : Closeable {
+        fun use(block: (T) -> Unit) = block(resourceFile)
+        override fun close() {
+            lockedResourceFileNames.remove(resourceFile.name)
+        }
+    }
+
+    override fun flush() {
+        TODO("Not yet implemented")
+    }
+
+    /**
+     * Open a resource file, creating it if the file does not exist.
+     *
+     * @param path The resource file path.
+     * @return The corresponding [ResourceFiles],
+     */
+    fun openFile(path: String) = ResourceFiles(createHandle(path), archive)
+
+    private fun getPackageBlock() = packageBlock ?: throw ApkResourceException.MissingResourceTable
+
+    internal fun getOrCreateString(value: String) =
+        tableBlock?.stringPool?.getOrCreate(value) ?: throw ApkResourceException.MissingResourceTable
+
+    private fun Entry.set(resource: Resource) {
+        val existingEntryNameReference = specReference
+
+        // Sets this.specReference if the entry is not yet initialized.
+        // Sets this.specReference to 0 if the resource type of the existing entry changes.
+        ensureComplex(resource.isComplex)
+
+        if (existingEntryNameReference != 0) {
+            // Preserve the entry name by restoring the previous spec block reference (if present).
+            specReference = existingEntryNameReference
+        }
+
+        resource.write(this, this@ResourceContainer)
+        resourceTable.registerChanged(this)
+    }
+
+    /**
+     * Retrieve an [Entry] from the resource table.
+     *
+     * @param type The resource type.
+     * @param name The resource name.
+     * @param qualifiers The variant to use.
+     */
+    private fun getEntry(type: String, name: String, qualifiers: String?): Entry? {
+        val resourceId = try {
+            resourceTable.resolve("@$type/$name")
+        } catch (_: ApkResourceException.InvalidReference) {
+            return null
+        }
+
+        val config = ResConfig.parse(qualifiers)
+        return tableBlock?.resolveReference(resourceId)?.singleOrNull { it.resConfig == config }
+    }
+
+    /**
+     * Create a [ResourceFiles.Handle] that can be used to open a [ResourceFiles].
+     * This may involve looking it up in the resource table to find the actual location in the archive.
+     *
+     * @param path The path of the resource.
+     */
+    private fun createHandle(path: String): ResourceFiles.Handle {
+        if (path.startsWith("res/values")) throw ApkResourceException.Decode("Decoding the resource table as a file is not supported")
+
+        var onClose = {}
+        var archivePath = path
+
+        if (tableBlock != null && path.startsWith("res/") && path.count { it == '/' } == 2) {
+            val file = File(path)
+
+            val qualifiers = EncodeUtil.getQualifiersFromResFile(file)
+            val type = EncodeUtil.getTypeNameFromResFile(file)
+            val name = file.nameWithoutExtension
+
+            // The resource file names that the app developers used may have been minified, so we have to resolve it with the resource table.
+            // Example: res/drawable-hdpi/icon.png -> res/4a.png
+            getEntry(type, name, qualifiers)?.resValue?.valueAsString?.let {
+                archivePath = it
+            } ?: run {
+                // An entry for this specific resource file was not found in the resource table, so we have to register it after we save.
+                onClose = { setResource(type, name, StringResource(archivePath), qualifiers) }
+            }
+        }
+
+        return ResourceFiles.Handle(path, archivePath, onClose)
+    }
+
+    fun setResource(type: String, entryName: String, resource: Resource, qualifiers: String? = null) =
+        getPackageBlock().getOrCreate(qualifiers, type, entryName).also { it.set(resource) }.resourceId
+
+    fun setResources(type: String, resources: Map<String, Resource>, configuration: String? = null) {
+        getPackageBlock().getOrCreateSpecTypePair(type).getOrCreateTypeBlock(configuration).apply {
+            resources.forEach { (entryName, resource) -> getOrCreateEntry(entryName).set(resource) }
+        }
+    }
+
+    override fun flush() {
+        packageBlock?.name = archive
+    }
+}

arsclib-utils/src/main/kotlin/app/revanced/arsc/resource/ResourceFiles.kt

@@ -0,0 +1,91 @@
+package app.revanced.arsc.resource
+
+import app.revanced.arsc.ApkResourceException
+import app.revanced.arsc.archive.Archive
+import com.reandroid.archive.InputSource
+import com.reandroid.xml.XMLDocument
+import com.reandroid.xml.XMLException
+import java.io.*
+
+
+abstract class ResourceFile(val name: String) {
+    internal var realName: String? = null
+
+    class XmlResourceFile(name: String, val document: XMLDocument) : ResourceFile(name)
+    class BinaryResourceFile(name: String, var bytes: ByteArray) : ResourceFile(name)
+}
+
+
+class ResourceFiles private constructor(
+) : Closeable {
+
+    /**
+     * Instantiate a [ResourceFiles].
+     *
+     * @param handle The [Handle] associated with this file.
+     * @param archive The [Archive] that the file resides in.
+     */
+    internal constructor(handle: Handle, archive: Archive) : this(
+        handle,
+        archive,
+        try {
+            archive.read(handle.archivePath)
+        } catch (e: XMLException) {
+            throw ApkResourceException.Decode("Failed to decode XML while reading ${handle.virtualPath}", e)
+        } catch (e: IOException) {
+            throw ApkResourceException.Decode("Could not read ${handle.virtualPath}", e)
+        }
+    )
+
+    companion object {
+        const val DEFAULT_BUFFER_SIZE = 1024
+    }
+
+    var contents = readResult?.data ?: ByteArray(0)
+        set(value) {
+            pendingWrite = true
+            field = value
+        }
+
+    val exists = readResult != null
+
+    override fun toString() = handle.virtualPath
+
+    override fun close() {
+        if (pendingWrite) {
+            val path = handle.archivePath
+
+            if (isXmlResource) archive.writeXml(
+                path,
+                try {
+                    XMLDocument.load(inputStream())
+                } catch (e: XMLException) {
+                    throw ApkResourceException.Encode("Failed to parse XML while writing ${handle.virtualPath}", e)
+                }
+
+            ) else archive.writeRaw(path, contents)
+        }
+
+        handle.onClose()
+
+
+        archive.unlock(this)
+    }
+
+    fun inputStream(): InputStream = ByteArrayInputStream(contents)
+
+    fun outputStream(bufferSize: Int = DEFAULT_BUFFER_SIZE): OutputStream =
+        object : ByteArrayOutputStream(bufferSize) {
+            override fun close() {
+                this@ResourceFiles.contents = if (buf.size > count) buf.copyOf(count) else buf
+                super.close()
+            }
+        }
+
+    /**
+     * @param virtualPath The resource file path. Example: /res/drawable-hdpi/icon.png.
+     * @param archivePath The actual file path in the archive. Example: res/4a.png.
+     * @param onClose An action to perform when the file associated with this handle is closed
+     */
+    internal data class Handle(val virtualPath: String, val archivePath: String, val onClose: () -> Unit)
+}

arsclib-utils/src/main/kotlin/app/revanced/arsc/resource/ResourceTable.kt

@@ -0,0 +1,100 @@
+package app.revanced.arsc.resource
+
+import app.revanced.arsc.ApkResourceException
+import com.reandroid.apk.xmlencoder.EncodeException
+import com.reandroid.apk.xmlencoder.EncodeMaterials
+import com.reandroid.arsc.util.FrameworkTable
+import com.reandroid.arsc.value.Entry
+import com.reandroid.common.TableEntryStore
+
+/**
+ * A high-level API for resolving resources in the resource table, which spans the entire ApkBundle.
+ */
+class ResourceTable(base: ResourceContainer, all: Sequence<ResourceContainer>) {
+    private val packageName = base.tableBlock!!.name
+
+    /**
+     * A [TableEntryStore] used to decode XML.
+     */
+    internal val entryStore = TableEntryStore()
+
+    /**
+     * The [EncodeMaterials] to use for resolving resources and encoding XML.
+     */
+    internal val encodeMaterials: EncodeMaterials = object : EncodeMaterials() {
+        /*
+        Our implementation is more efficient because it does not have to loop through every single entry group
+        when the resource id cannot be found in the TableIdentifier, which does not update when you create a new resource.
+        It also looks at the entire table instead of just the current package.
+        */
+        override fun resolveLocalResourceId(type: String, name: String) = resolveLocal(type, name)
+    }
+
+    /**
+     * The resource mappings which are generated when the ApkBundle is created.
+     */
+    private val tableIdentifier = encodeMaterials.tableIdentifier
+
+    /**
+     * A table of all the resources that have been changed or added.
+     */
+    private val modifiedResources = HashMap<String, HashMap<String, Int>>()
+
+
+    /**
+     * Resolve a resource id for the specified resource.
+     * Cannot resolve resources from the android framework.
+     *
+     * @param type The type of the resource.
+     * @param name The name of the resource.
+     * @return The id of the resource.
+     */
+    fun resolveLocal(type: String, name: String) =
+        modifiedResources[type]?.get(name)
+            ?: tableIdentifier.get(packageName, type, name)?.resourceId
+            ?: throw ApkResourceException.InvalidReference(
+                type,
+                name
+            )
+
+    /**
+     * Resolve a resource id for the specified resource.
+     *
+     * @param reference The resource reference string.
+     * @return The id of the resource.
+     */
+    fun resolve(reference: String) = try {
+        encodeMaterials.resolveReference(reference)
+    } catch (e: EncodeException) {
+        throw ApkResourceException.InvalidReference(reference, e)
+    }
+
+    /**
+     * Notify the [ResourceTable] that an [Entry] has been created or modified.
+     */
+    internal fun registerChanged(entry: Entry) {
+        modifiedResources.getOrPut(entry.typeName, ::HashMap)[entry.name] = entry.resourceId
+    }
+
+    init {
+        all.forEach {
+            it.tableBlock?.let { table ->
+                entryStore.add(table)
+                tableIdentifier.load(table)
+            }
+
+            it.resourceTable = this
+        }
+
+        base.also {
+            encodeMaterials.currentPackage = it.tableBlock
+
+            it.tableBlock!!.frameWorks.forEach { fw ->
+                if (fw is FrameworkTable) {
+                    entryStore.add(fw)
+                    encodeMaterials.addFramework(fw)
+                }
+            }
+        }
+    }
+}

arsclib-utils/src/main/kotlin/app/revanced/arsc/xml/LazyXMLEncodeSource.kt

@@ -0,0 +1,56 @@
+package app.revanced.arsc.xml
+
+import app.revanced.arsc.resource.ResourceContainer
+import app.revanced.arsc.resource.boolean
+import com.reandroid.apk.xmlencoder.EncodeException
+import com.reandroid.apk.xmlencoder.XMLEncodeSource
+import com.reandroid.arsc.chunk.xml.ResXmlDocument
+import com.reandroid.xml.XMLDocument
+import com.reandroid.xml.XMLElement
+import com.reandroid.xml.source.XMLDocumentSource
+
+/**
+ * Archive input source to lazily encode an [XMLDocument] after it has been modified.
+ *
+ * @param name The file name of this input source.
+ * @param document The [XMLDocument] to encode.
+ * @param resources The [ResourceContainer] to use for encoding.
+ */
+internal class LazyXMLEncodeSource(
+    name: String,
+    val document: XMLDocument,
+    private val resources: ResourceContainer
+) : XMLEncodeSource(resources.resourceTable.encodeMaterials, XMLDocumentSource(name, document)) {
+    private var encoded = false
+
+    override fun getResXmlBlock(): ResXmlDocument {
+        if (encoded) return super.getResXmlBlock()
+
+        XMLEncodeSource(resources.resourceTable.encodeMaterials, XMLDocumentSource(name, document))
+        
+        fun XMLElement.registerIds() {
+            listAttributes().forEach { attr ->
+                if (!attr.value.startsWith("@+id/")) return@forEach
+
+                val name = attr.value.split('/').last()
+                resources.setResource("id", name, boolean(false))
+                attr.value = "@id/$name"
+            }
+
+            listChildElements().forEach { it.registerIds() }
+        }
+
+        // Handle all @+id/id_name references in the document.
+        document.documentElement.registerIds()
+
+        encoded = true
+
+        // This will call XMLEncodeSource.getResXmlBlock(),
+        // which will encode the document if it has not already been encoded.
+        try {
+            return super.getResXmlBlock()
+        } catch (e: EncodeException) {
+            throw EncodeException("Failed to encode $name", e)
+        }
+    }
+}

build.gradle.kts

@@ -1,64 +1,3 @@
 plugins {
-    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 {
-            username = githubUsername
-            password = githubPassword
-        }
-    }
-}
-
-dependencies {
-    implementation(kotlin("stdlib"))
-    implementation(kotlin("reflect"))
-
-    api("xpp3:xpp3:1.1.4c")
-    api("org.apktool:apktool-lib:2.6.5-SNAPSHOT")
-    api("app.revanced:multidexlib2:2.5.2.r2")
-    api("org.smali:smali:2.5.2")
-
-    testImplementation(kotlin("test"))
-}
-
-tasks {
-    test {
-        useJUnitPlatform()
-        testLogging {
-            events("PASSED", "SKIPPED", "FAILED")
-        }
-    }
-}
-
-java {
-    withSourcesJar()
-}
-
-publishing {
-    repositories {
-            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 {
-        register<MavenPublication>("gpr") {
-            from(components["java"])
-        }
-    }
+    kotlin("jvm") version "1.8.20" apply false
 }

gradle.properties

@@ -1,2 +1,4 @@
+org.gradle.parallel=true
+org.gradle.caching=true
 kotlin.code.style = official
-version = 1.3.0
+version = 11.0.4