chore(release): 1.2.5 [skip ci]

## [1.2.5](https://github.com/revanced/revanced-patcher/compare/v1.2.4...v1.2.5) (2022-06-17)

### Bug Fixes

* goodbye security ([8f3ac77](8f3ac7702a))

CHANGELOG.md

@@ -1,3 +1,58 @@
+## [1.2.5](https://github.com/revanced/revanced-patcher/compare/v1.2.4...v1.2.5) (2022-06-17)
+
+
+### Bug Fixes
+
+* goodbye security ([8f3ac77](https://github.com/revanced/revanced-patcher/commit/8f3ac7702a2b3ee98c55aeac6a1b9972f99664cc))
+
+## [1.2.4](https://github.com/revanced/revanced-patcher/compare/v1.2.3...v1.2.4) (2022-06-15)
+
+
+### Reverts
+
+* "fix: enforce aapt v1" ([dfd8a24](https://github.com/revanced/revanced-patcher/commit/dfd8a245124f85b1b028bbba197c70c8dca689b6))
+
+## [1.2.3](https://github.com/revanced/revanced-patcher/compare/v1.2.2...v1.2.3) (2022-06-14)
+
+
+### Bug Fixes
+
+* enforce aapt v1 ([cff87ff](https://github.com/revanced/revanced-patcher/commit/cff87ff0770d774d7ef79eec5a22462eadbcb9c5))
+
+## [1.2.2](https://github.com/revanced/revanced-patcher/compare/v1.2.1...v1.2.2) (2022-06-14)
+
+
+### Bug Fixes
+
+* enforce aapt v2 ([b68b0bf](https://github.com/revanced/revanced-patcher/commit/b68b0bf3d735f54b92ad7dad8132f77e9007063f))
+
+## [1.2.1](https://github.com/revanced/revanced-patcher/compare/v1.2.0...v1.2.1) (2022-06-14)
+
+
+### Bug Fixes
+
+* Patcher setting BuildOptions too late ([6a5c873](https://github.com/revanced/revanced-patcher/commit/6a5c8735fb8a5d6f7e9c606734b6684c7fa99e7f))
+
+# [1.2.0](https://github.com/revanced/revanced-patcher/compare/v1.1.0...v1.2.0) (2022-06-14)
+
+
+### Features
+
+* allow custom framework path to be specified ([d3a580e](https://github.com/revanced/revanced-patcher/commit/d3a580ea19d7c2d5d8c97650b1e6396ea0a7fc25))
+
+# [1.1.0](https://github.com/revanced/revanced-patcher/compare/v1.0.0...v1.1.0) (2022-06-11)
+
+
+### Bug Fixes
+
+* resource patcher ([31815ca](https://github.com/revanced/revanced-patcher/commit/31815ca9ea990f16b3600d61fd570c1805be1c82))
+* update apktool to fork ([566ecef](https://github.com/revanced/revanced-patcher/commit/566ecefa2bd4cde5ebfb2b22dc56cd8bf9f396bd))
+
+
+### Features
+
+* allow custom aapt path to be specified ([8eb4a8f](https://github.com/revanced/revanced-patcher/commit/8eb4a8f87ae7679a272f3224273a37a31d4bb121))
+
 # 1.0.0 (2022-06-05)
 
 

build.gradle.kts

@@ -1,24 +1,21 @@
 plugins {
-    kotlin("jvm") version "1.6.21"
+    kotlin("jvm") version "1.7.0"
     java
     `maven-publish`
 }
 
 group = "app.revanced"
 
+val githubUsername: String = project.findProperty("gpr.user") as? String ?: System.getenv("GITHUB_ACTOR")
+val githubPassword: String = project.findProperty("gpr.key") as? String ?: System.getenv("GITHUB_TOKEN")
+
 repositories {
     mavenCentral()
     maven {
         url = uri("https://maven.pkg.github.com/revanced/multidexlib2")
         credentials {
-            // DO NOT set these variables in the project's gradle.properties.
+            username = githubUsername
-            // Instead, you should set them in:
+            password = githubPassword
-            // 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!
         }
     }
 }
@@ -27,13 +24,12 @@ dependencies {
     implementation(kotlin("stdlib"))
 
     api("xpp3:xpp3:1.1.4c")
-    api("org.apktool:apktool-lib:2.6.1")
+    api("org.apktool:apktool-lib:2.6.2-SNAPSHOT")
     api("app.revanced:multidexlib2:2.5.2.r2")
     api("org.smali:smali:2.5.2")
 
     testImplementation(kotlin("test"))
-    implementation(kotlin("reflect"))
+    implementation(kotlin("reflect"))}
-}
 
 tasks {
     test {
@@ -49,11 +45,8 @@ java {
     withJavadocJar()
 }
 
-val isGitHubCI = System.getenv("GITHUB_ACTOR") != null
-
 publishing {
     repositories {
-        if (isGitHubCI) {
             maven {
                 name = "GitHubPackages"
                 url = uri("https://maven.pkg.github.com/revanced/revanced-patcher")
@@ -62,9 +55,6 @@ publishing {
                     password = System.getenv("GITHUB_TOKEN")
                 }
             }
-        } else {
-            mavenLocal()
-        }
     }
     publications {
         register<MavenPublication>("gpr") {

gradle.properties

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

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

@@ -1,5 +1,6 @@
 package app.revanced.patcher
 
+import app.revanced.patcher.data.PackageMetadata
 import app.revanced.patcher.data.PatcherData
 import app.revanced.patcher.data.base.Data
 import app.revanced.patcher.data.implementation.findIndexed
@@ -16,11 +17,13 @@ import app.revanced.patcher.signature.implementation.method.resolver.MethodSigna
 import app.revanced.patcher.util.ListBackedSet
 import brut.androlib.Androlib
 import brut.androlib.meta.UsesFramework
+import brut.androlib.options.BuildOptions
 import brut.androlib.res.AndrolibResources
 import brut.androlib.res.data.ResPackage
 import brut.androlib.res.decoder.AXmlResourceParser
 import brut.androlib.res.decoder.ResAttrDecoder
 import brut.androlib.res.decoder.XmlPullStreamDecoder
+import brut.androlib.res.xml.ResXmlPatcher
 import brut.directory.ExtFile
 import lanchon.multidexlib2.BasicDexFileNamer
 import lanchon.multidexlib2.DexIO
@@ -30,6 +33,7 @@ import org.jf.dexlib2.iface.ClassDef
 import org.jf.dexlib2.iface.DexFile
 import org.jf.dexlib2.writer.io.MemoryDataStore
 import java.io.File
+import java.nio.file.Files
 
 val NAMER = BasicDexFileNamer()
 
@@ -37,35 +41,35 @@ val NAMER = BasicDexFileNamer()
  * The ReVanced Patcher.
  * @param options The options for the patcher.
  */
-class Patcher(
+class Patcher(private val options: PatcherOptions) {
-    private val options: PatcherOptions
+    val data: PatcherData
-) {
-    val packageVersion: String
-    val packageName: String
-
-    private lateinit var usesFramework: UsesFramework
-    private val patcherData: PatcherData
     private val opcodes: Opcodes
 
     init {
-        val extFileInput = ExtFile(options.inputFile)
+        val extInputFile = ExtFile(options.inputFile)
         val outDir = File(options.resourceCacheDirectory)
-
         if (outDir.exists()) outDir.deleteRecursively()
-        outDir.mkdir()
+        outDir.mkdirs()
 
-        // load the resource table from the input file
+        val androlib = Androlib(BuildOptions().also { it.setBuildOptions(options) })
-        val androlib = Androlib()
+        val resourceTable = androlib.getResTable(extInputFile, true)
-        val resourceTable = androlib.getResTable(extFileInput, true)
+
+        val packageMetadata = PackageMetadata()
 
         if (options.patchResources) {
-            // 1. decode resources to cache directory
+            // decode resources to cache directory
-            androlib.decodeManifestWithResources(extFileInput, outDir, resourceTable)
+            androlib.decodeManifestWithResources(extInputFile, outDir, resourceTable)
-            androlib.decodeResourcesFull(extFileInput, outDir, resourceTable)
+            androlib.decodeResourcesFull(extInputFile, outDir, resourceTable)
+
+            // read additional metadata from the resource table
+            packageMetadata.metaInfo.usesFramework = UsesFramework().also { framework ->
+                framework.ids = resourceTable.listFramePackages().map { it.id }.sorted()
+            }
+
+            packageMetadata.metaInfo.doNotCompress = buildList {
+                androlib.recordUncompressedFiles(extInputFile, this)
+            }
 
-            // 2. read framework ids from the resource table
-            usesFramework = UsesFramework()
-            usesFramework.ids = resourceTable.listFramePackages().map { it.id }.sorted()
         } else {
             // create decoder for the resource table
             val decoder = ResAttrDecoder()
@@ -80,19 +84,24 @@ class Patcher(
             XmlPullStreamDecoder(
                 axmlParser, AndrolibResources().resXmlSerializer
             ).decodeManifest(
-                extFileInput.directory.getFileInput("AndroidManifest.xml"), nullOutputStream
+                extInputFile.directory.getFileInput("AndroidManifest.xml"), nullOutputStream
             )
         }
 
-        // set package information
+        packageMetadata.packageName = resourceTable.currentResPackage.name
-        packageVersion = resourceTable.versionInfo.versionName
+        packageMetadata.packageVersion = resourceTable.versionInfo.versionName
-        packageName = resourceTable.currentResPackage.name
+        packageMetadata.metaInfo.versionInfo = resourceTable.versionInfo
+        packageMetadata.metaInfo.sdkInfo = resourceTable.sdkInfo
+
         // read dex files
         val dexFile = MultiDexIO.readDexFile(true, options.inputFile, NAMER, null, null)
+        // get the opcodes
         opcodes = dexFile.opcodes
 
-        // save to patcher data
+        // finally create patcher data
-        patcherData = PatcherData(dexFile.classes.toMutableList(), options.resourceCacheDirectory)
+        data = PatcherData(
+            dexFile.classes.toMutableList(), options.resourceCacheDirectory, packageMetadata
+        )
     }
 
     /**
@@ -102,23 +111,22 @@ class Patcher(
      * @param throwOnDuplicates If this is set to true, the patcher will throw an exception if a duplicate class has been found.
      */
     fun addFiles(
-        files: Iterable<File>, allowedOverwrites: Iterable<String> = emptyList(), throwOnDuplicates: Boolean = false
+        files: List<File>, allowedOverwrites: Iterable<String> = emptyList(), throwOnDuplicates: Boolean = false
     ) {
         for (file in files) {
-            val dexFile = MultiDexIO.readDexFile(true, file, NAMER, null, null)
+            for (classDef in MultiDexIO.readDexFile(true, file, NAMER, null, null).classes) {
-            for (classDef in dexFile.classes) {
+                val e = data.bytecodeData.classes.internalClasses.findIndexed { it.type == classDef.type }
-                val e = patcherData.bytecodeData.classes.internalClasses.findIndexed { it.type == classDef.type }
                 if (e != null) {
                     if (throwOnDuplicates) {
                         throw Exception("Class ${classDef.type} has already been added to the patcher.")
                     }
                     val (_, idx) = e
                     if (allowedOverwrites.contains(classDef.type)) {
-                        patcherData.bytecodeData.classes.internalClasses[idx] = classDef
+                        data.bytecodeData.classes.internalClasses[idx] = classDef
                     }
                     continue
                 }
-                patcherData.bytecodeData.classes.internalClasses.add(classDef)
+                data.bytecodeData.classes.internalClasses.add(classDef)
             }
         }
     }
@@ -126,11 +134,58 @@ class Patcher(
     /**
      * Save the patched dex file.
      */
-    fun save(): Map<String, MemoryDataStore> {
+    fun save(): PatcherResult {
+        val packageMetadata = data.packageMetadata
+        val metaInfo = packageMetadata.metaInfo
+
+        if (options.patchResources) {
+            val cacheDirectory = ExtFile(options.resourceCacheDirectory)
+
+            val androlibResources = AndrolibResources().also { resources ->
+                resources.buildOptions = BuildOptions().also { buildOptions ->
+                    buildOptions.setBuildOptions(options)
+                    buildOptions.isFramework = metaInfo.isFrameworkApk
+                    buildOptions.resourcesAreCompressed = metaInfo.compressionType
+                    buildOptions.doNotCompress = metaInfo.doNotCompress
+                }
+
+                resources.setSdkInfo(metaInfo.sdkInfo)
+                resources.setVersionInfo(metaInfo.versionInfo)
+                resources.setSharedLibrary(metaInfo.sharedLibrary)
+                resources.setSparseResources(metaInfo.sparseResources)
+            }
+
+            val manifestFile = cacheDirectory.resolve("AndroidManifest.xml")
+
+            ResXmlPatcher.fixingPublicAttrsInProviderAttributes(manifestFile)
+
+            val aaptFile = cacheDirectory.resolve("aapt_temp_file")
+
+            // delete if it exists
+            Files.deleteIfExists(aaptFile.toPath())
+
+            val resDirectory = cacheDirectory.resolve("res")
+            val includedFiles = metaInfo.usesFramework.ids.map { id ->
+                androlibResources.getFrameworkApk(
+                    id,
+                    metaInfo.usesFramework.tag
+                )
+            }.toTypedArray()
+
+            androlibResources.aaptPackage(
+                aaptFile, manifestFile, resDirectory, null,
+                null, includedFiles
+            )
+
+            // write packaged resources to cache directory
+            ExtFile(aaptFile).directory.copyToDir(cacheDirectory.resolve("build/"))
+
+        }
+
         val newDexFile = object : DexFile {
             override fun getClasses(): Set<ClassDef> {
-                patcherData.bytecodeData.classes.applyProxies()
+                data.bytecodeData.classes.applyProxies()
-                return ListBackedSet(patcherData.bytecodeData.classes.internalClasses)
+                return ListBackedSet(data.bytecodeData.classes.internalClasses)
             }
 
             override fun getOpcodes(): Opcodes {
@@ -138,21 +193,19 @@ class Patcher(
             }
         }
 
-        // build modified resources
-        if (options.patchResources) {
-            val extDir = ExtFile(options.resourceCacheDirectory)
-
-            // TODO: figure out why a new instance of Androlib is necessary here
-            Androlib().buildResources(extDir, usesFramework)
-        }
-
         // write dex modified files
-        val output = mutableMapOf<String, MemoryDataStore>()
+        val dexFiles = mutableMapOf<String, MemoryDataStore>()
         MultiDexIO.writeDexFile(
             true, -1, // core count
-            output, NAMER, newDexFile, DexIO.DEFAULT_MAX_DEX_POOL_SIZE, null
+            dexFiles, NAMER, newDexFile, DexIO.DEFAULT_MAX_DEX_POOL_SIZE, null
+        )
+
+        return PatcherResult(
+            dexFiles.map {
+                app.revanced.patcher.util.dex.DexFile(it.key, it.value)
+            },
+            metaInfo.doNotCompress.toList()
         )
-        return output
     }
 
     /**
@@ -160,7 +213,7 @@ class Patcher(
      * @param patches [Patch]es The patches to add.
      */
     fun addPatches(patches: Iterable<Class<out Patch<Data>>>) {
-        patcherData.patches.addAll(patches)
+        data.patches.addAll(patches)
     }
 
     /**
@@ -197,12 +250,12 @@ class Patcher(
 
         // TODO: find a solution for this
         val data = if (isResourcePatch) {
-            patcherData.resourceData
+            data.resourceData
         } else {
             MethodSignatureResolver(
-                patcherData.bytecodeData.classes.internalClasses, (patchInstance as BytecodePatch).signatures
+                data.bytecodeData.classes.internalClasses, (patchInstance as BytecodePatch).signatures
-            ).resolve(patcherData)
+            ).resolve(data)
-            patcherData.bytecodeData
+            data.bytecodeData
         }
 
         return try {
@@ -225,7 +278,7 @@ class Patcher(
         val appliedPatches = mutableListOf<String>()
 
         return buildMap {
-            for (patch in patcherData.patches) {
+            for (patch in data.patches) {
                 val result = applyPatch(patch, appliedPatches)
 
                 val name = patch.patchName
@@ -242,3 +295,9 @@ class Patcher(
         }
     }
 }
+
+private fun BuildOptions.setBuildOptions(options: PatcherOptions) {
+    this.aaptPath = options.aaptPath
+    this.useAapt2 = true
+    this.frameworkFolderLocation = options.frameworkFolderLocation
+}

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

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

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

@@ -0,0 +1,13 @@
+package app.revanced.patcher
+
+import app.revanced.patcher.util.dex.DexFile
+
+/**
+ * The result of a patcher.
+ * @param dexFiles The patched dex files.
+ * @param doNotCompress List of relative paths to files to exclude from compressing.
+ */
+data class PatcherResult(
+    val dexFiles: List<DexFile>,
+    val doNotCompress: List<String>? = null
+)

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

@@ -7,10 +7,12 @@ import app.revanced.patcher.patch.base.Patch
 import org.jf.dexlib2.iface.ClassDef
 import java.io.File
 
-internal data class PatcherData(
+data class PatcherData(
-    val internalClasses: MutableList<ClassDef>,
+    internal val internalClasses: MutableList<ClassDef>,
-    val resourceCacheDirectory: String
+    internal val resourceCacheDirectory: String,
+    val packageMetadata: PackageMetadata
 ) {
+
     internal val patches = mutableListOf<Class<out Patch<Data>>>()
 
     internal val bytecodeData = BytecodeData(internalClasses)

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

@@ -34,7 +34,6 @@ class DomFileEditor internal constructor(private val domFile: File) : Closeable
 
     init {
         val factory = DocumentBuilderFactory.newInstance()
-        factory.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, true)
 
         val builder = factory.newDocumentBuilder()
 

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

@@ -41,13 +41,15 @@ object PatchExtensions {
     val Class<out Patch<Data>>.patchName: String
         get() = recursiveAnnotation(Name::class)?.name ?: this.javaClass.simpleName
     val Class<out Patch<Data>>.version get() = recursiveAnnotation(Version::class)?.version
+    val Class<out Patch<Data>>.include get() = recursiveAnnotation(app.revanced.patcher.patch.annotations.Patch::class)!!.include
     val Class<out Patch<Data>>.description get() = recursiveAnnotation(Description::class)?.description
     val Class<out Patch<Data>>.dependencies get() = recursiveAnnotation(app.revanced.patcher.patch.annotations.Dependencies::class)?.dependencies
     val Class<out Patch<Data>>.compatiblePackages get() = recursiveAnnotation(Compatibility::class)?.compatiblePackages
 }
 
 object MethodSignatureExtensions {
-    val MethodSignature.name: String get() = javaClass.recursiveAnnotation(Name::class)?.name ?: this.javaClass.simpleName
+    val MethodSignature.name: String
+        get() = javaClass.recursiveAnnotation(Name::class)?.name ?: this.javaClass.simpleName
     val MethodSignature.version get() = javaClass.recursiveAnnotation(Version::class)?.version ?: "0.0.1"
     val MethodSignature.description get() = javaClass.recursiveAnnotation(Description::class)?.description
     val MethodSignature.compatiblePackages get() = javaClass.recursiveAnnotation(Compatibility::class)?.compatiblePackages

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

@@ -6,11 +6,12 @@ import kotlin.reflect.KClass
 
 /**
  * Annotation to mark a Class as a patch.
+ * @param include If false, the patch should be treated as optional by default.
  */
 @Target(AnnotationTarget.CLASS)
 @Retention(AnnotationRetention.RUNTIME)
 @MustBeDocumented
-annotation class Patch
+annotation class Patch(val include: Boolean = true)
 
 /**
  * Annotation for dependencies of [Patch]es .

src/main/kotlin/app/revanced/patcher/signature/implementation/method/resolver/MethodSignatureResolver.kt

@@ -76,19 +76,17 @@ internal class MethodSignatureResolver(
             signature.strings?.let { strings ->
                 method.implementation ?: return null
 
-                method.implementation!!.instructions.let { instructions ->
+                val stringsList = strings.toMutableList()
-                    val stringsList = strings.toMutableList()
 
-                    for (instruction in instructions) {
+                for (instruction in method.implementation!!.instructions) {
-                        if (instruction.opcode != Opcode.CONST_STRING) continue
+                    if (instruction.opcode != Opcode.CONST_STRING) continue
 
-                        val string = ((instruction as Instruction21c).reference as StringReference).string
+                    val string = ((instruction as Instruction21c).reference as StringReference).string
-                        val i = stringsList.indexOfFirst { it == string }
+                    val i = stringsList.indexOfFirst { it == string }
-                        if (i != -1) stringsList.removeAt(i)
+                    if (i != -1) stringsList.removeAt(i)
-                    }
-
-                    if (stringsList.isNotEmpty()) return null
                 }
+
+                if (stringsList.isNotEmpty()) return null
             }
 
             return if (signature.opcodes == null) {

src/main/kotlin/app/revanced/patcher/util/dex/DexFile.kt

@@ -0,0 +1,10 @@
+package app.revanced.patcher.util.dex
+
+import org.jf.dexlib2.writer.io.MemoryDataStore
+
+/**
+ * Wrapper for dex files.
+ * @param name The original name of the dex file
+ * @param memoryDataStore The data store for the dex file.
+ */
+data class DexFile(val name: String, val memoryDataStore: MemoryDataStore)