chore(release): 1.11.0 [skip ci]

# [1.11.0](https://github.com/revanced/revanced-patcher/compare/v1.10.2...v1.11.0) (2022-06-24)

### Features

* add replace and remove extensions ([#50](https://github.com/revanced/revanced-patcher/issues/50)) ([92ac5e4](92ac5e4dc2))

CHANGELOG.md

@@ -1,3 +1,51 @@
+# [1.11.0](https://github.com/revanced/revanced-patcher/compare/v1.10.2...v1.11.0) (2022-06-24)
+
+
+### Features
+
+* add replace and remove extensions ([#50](https://github.com/revanced/revanced-patcher/issues/50)) ([92ac5e4](https://github.com/revanced/revanced-patcher/commit/92ac5e4dc25f612856e2b5e528cf5fd48a5f20af))
+
+## [1.10.2](https://github.com/revanced/revanced-patcher/compare/v1.10.1...v1.10.2) (2022-06-23)
+
+
+### Bug Fixes
+
+* dexlib must be propagated ([b738dcd](https://github.com/revanced/revanced-patcher/commit/b738dcd7ea04f5fe56e66af46fb11541fe54f6af))
+
+## [1.10.1](https://github.com/revanced/revanced-patcher/compare/v1.10.0...v1.10.1) (2022-06-23)
+
+
+### Bug Fixes
+
+* callback only when inteded ([e3bf367](https://github.com/revanced/revanced-patcher/commit/e3bf367ad6615b30b06027d65f906b2588567a7f))
+* mutability of local variable `modified` ([0e87ef5](https://github.com/revanced/revanced-patcher/commit/0e87ef56c418d5c37d58abb9b27f85e25fd44f81))
+
+# [1.10.0](https://github.com/revanced/revanced-patcher/compare/v1.9.0...v1.10.0) (2022-06-23)
+
+
+### Features
+
+* improve logging ([c20dfe1](https://github.com/revanced/revanced-patcher/commit/c20dfe12d5c737264b844e6634de11bf1e1629f0))
+
+# [1.9.0](https://github.com/revanced/revanced-patcher/compare/v1.8.0...v1.9.0) (2022-06-22)
+
+
+### Bug Fixes
+
+* callback for each file instead of class ([930768d](https://github.com/revanced/revanced-patcher/commit/930768dfb31dc5fa6c248050b08ac117c40ee0a3))
+
+
+### Features
+
+* yield the patch result ([dde5385](https://github.com/revanced/revanced-patcher/commit/dde5385232abddc8a85d6e9a939549b71dd9130e))
+
+# [1.8.0](https://github.com/revanced/revanced-patcher/compare/v1.7.2...v1.8.0) (2022-06-22)
+
+
+### Features
+
+* logging class ([caf2745](https://github.com/revanced/revanced-patcher/commit/caf2745805ffd4b59fa81e79cc489b1a1a5c5d89))
+
 ## [1.7.2](https://github.com/revanced/revanced-patcher/compare/v1.7.1...v1.7.2) (2022-06-22)
 
 

build.gradle.kts

@@ -21,8 +21,9 @@ repositories {
 }
 
 dependencies {
+    api("app.revanced:multidexlib2:2.5.2.r2")
+
     implementation("xpp3:xpp3:1.1.4c")
-    implementation("app.revanced:multidexlib2:2.5.2.r2")
     implementation("org.smali:smali:2.5.2")
     implementation("org.apktool:apktool-lib:2.6.5-SNAPSHOT")
 

gradle.properties

@@ -1,2 +1,2 @@
 kotlin.code.style = official
-version = 1.7.2
+version = 1.11.0

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

@@ -1,15 +0,0 @@
-package app.revanced.patcher
-
-interface PatchLogger {
-    fun error(msg: String)
-    fun warn(msg: String)
-    fun info(msg: String)
-    fun trace(msg: String)
-}
-
-internal object NoopPatchLogger : PatchLogger {
-    override fun error(msg: String) {}
-    override fun warn(msg: String) {}
-    override fun info(msg: String) {}
-    override fun trace(msg: String) {}
-}

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

@@ -62,7 +62,7 @@ class Patcher(private val options: PatcherOptions) {
         val packageMetadata = PackageMetadata()
 
         if (options.patchResources) {
-            logger.info("Decoding resources using Androlib, this may take a long time...")
+            logger.info("Decoding resources")
 
             // decode resources to cache directory
             androlib.decodeManifestWithResources(extInputFile, outDir, resourceTable)
@@ -78,7 +78,7 @@ class Patcher(private val options: PatcherOptions) {
             }
 
         } else {
-            logger.info("Decoding resources manually because resource decoding is disabled!")
+            logger.info("Only decoding AndroidManifest.xml because resource patching is disabled")
 
             // create decoder for the resource table
             val decoder = ResAttrDecoder()
@@ -102,8 +102,9 @@ class Patcher(private val options: PatcherOptions) {
         packageMetadata.metaInfo.versionInfo = resourceTable.versionInfo
         packageMetadata.metaInfo.sdkInfo = resourceTable.sdkInfo
 
+        logger.info("Reading dex files")
+
         // read dex files
-        logger.info("Reading input as dex file")
         val dexFile = MultiDexIO.readDexFile(true, options.inputFile, NAMER, null, null)
         // get the opcodes
         opcodes = dexFile.opcodes
@@ -129,25 +130,28 @@ class Patcher(private val options: PatcherOptions) {
         for (file in files) {
             var modified = false
             for (classDef in MultiDexIO.readDexFile(true, file, NAMER, null, null).classes) {
-                val e = data.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)) {
-                        data.bytecodeData.classes.internalClasses[idx] = classDef
-                        modified = true
-                    }
+                val type = classDef.type
+
+                val existingClass = data.bytecodeData.classes.internalClasses.findIndexed { it.type == type }
+                if (existingClass == null) {
+                    if (throwOnDuplicates) throw Exception("Class $type has already been added to the patcher")
+
+                    logger.trace("Merging $type")
+                    data.bytecodeData.classes.internalClasses.add(classDef)
+                    modified = true
+
                     continue
                 }
-                data.bytecodeData.classes.internalClasses.add(classDef)
+
+                if (!allowedOverwrites.contains(type)) continue
+
+                logger.trace("Overwriting $type")
+
+                val index = existingClass.second
+                data.bytecodeData.classes.internalClasses[index] = classDef
                 modified = true
             }
-            if (modified) {
-                logger.trace("Added file ${file.name}")
-                callback(file)
-            }
+            if (modified) callback(file)
         }
     }
 
@@ -160,7 +164,6 @@ class Patcher(private val options: PatcherOptions) {
         var resourceFile: File? = null
 
         if (options.patchResources) {
-            logger.info("Patching resources")
             val cacheDirectory = ExtFile(options.resourceCacheDirectory)
 
             val androlibResources = AndrolibResources().also { resources ->
@@ -189,15 +192,13 @@ class Patcher(private val options: PatcherOptions) {
             val resDirectory = cacheDirectory.resolve("res")
             val includedFiles = metaInfo.usesFramework.ids.map { id ->
                 androlibResources.getFrameworkApk(
-                    id,
-                    metaInfo.usesFramework.tag
+                    id, metaInfo.usesFramework.tag
                 )
             }.toTypedArray()
 
-            logger.trace("Packaging using aapt")
+            logger.info("Compiling resources")
             androlibResources.aaptPackage(
-                aaptFile, manifestFile, resDirectory, null,
-                null, includedFiles
+                aaptFile, manifestFile, resDirectory, null, null, includedFiles
             )
 
             resourceFile = aaptFile
@@ -226,9 +227,7 @@ class Patcher(private val options: PatcherOptions) {
         return PatcherResult(
             dexFiles.map {
                 app.revanced.patcher.util.dex.DexFile(it.key, it.value.readAt(0))
-            },
-            metaInfo.doNotCompress.toList(),
-            resourceFile
+            }, metaInfo.doNotCompress.toList(), resourceFile
         )
     }
 
@@ -247,15 +246,14 @@ class Patcher(private val options: PatcherOptions) {
      * @return The result of executing the [patch].
      */
     private fun applyPatch(
-        patch: Class<out Patch<Data>>,
-        appliedPatches: MutableList<String>
+        patch: Class<out Patch<Data>>, appliedPatches: MutableList<String>
     ): PatchResult {
         val patchName = patch.patchName
-        logger.trace("Applying patch $patchName")
 
         // if the patch has already applied silently skip it
         if (appliedPatches.contains(patchName)) {
             logger.trace("Skipping patch $patchName because it has already been applied")
+
             return PatchResultSuccess()
         }
         appliedPatches.add(patchName)
@@ -290,6 +288,7 @@ class Patcher(private val options: PatcherOptions) {
         }
 
         logger.trace("Executing patch $patchName of type: ${if (isResourcePatch) "resource" else "bytecode"}")
+
         return try {
             patchInstance.execute(data)
         } catch (e: Exception) {
@@ -300,30 +299,23 @@ class Patcher(private val options: PatcherOptions) {
     /**
      * Apply patches loaded into the patcher.
      * @param stopOnError If true, the patches will stop on the first error.
-     * @return A map of [PatchResultSuccess]. If the [Patch] was successfully applied,
-     * [PatchResultSuccess] will always be returned to the wrapping Result object.
-     * If the [Patch] failed to apply, an Exception will always be returned to the wrapping Result object.
+     * @return A pair of the name of the [Patch] and its [PatchResult].
      */
-    fun applyPatches(
-        stopOnError: Boolean = false,
-        callback: (Class<out Patch<Data>>, Boolean) -> Unit = { _, _ -> }
-    ): Map<String, Result<PatchResultSuccess>> {
+    fun applyPatches(stopOnError: Boolean = false) = sequence {
         logger.trace("Applying all patches")
         val appliedPatches = mutableListOf<String>()
 
-        return buildMap {
-            for (patch in data.patches) {
-                val result = applyPatch(patch, appliedPatches)
+        for (patch in data.patches) {
+            val patchResult = applyPatch(patch, appliedPatches)
 
-                this[patch.patchName] = if (result.isSuccess()) {
-                    Result.success(result.success()!!)
-                } else {
-                    Result.failure(result.error()!!)
-                }
-
-                callback(patch, result.isSuccess())
-                if (stopOnError && result.isError()) break
+            val result = if (patchResult.isSuccess()) {
+                Result.success(patchResult.success()!!)
+            } else {
+                Result.failure(patchResult.error()!!)
             }
+
+            yield(patch.patchName to result)
+            if (stopOnError && patchResult.isError()) break
         }
     }
 }
@@ -332,4 +324,4 @@ 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

@@ -1,5 +1,7 @@
 package app.revanced.patcher
 
+import app.revanced.patcher.logging.impl.NopLogger
+import app.revanced.patcher.logging.Logger
 import java.io.File
 
 /**
@@ -17,5 +19,5 @@ data class PatcherOptions(
     internal val patchResources: Boolean = false,
     internal val aaptPath: String = "",
     internal val frameworkFolderLocation: String? = null,
-    internal val logger: PatchLogger = NoopPatchLogger
+    internal val logger: Logger = NopLogger
 )

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

@@ -23,6 +23,18 @@ fun MutableMethodImplementation.addInstructions(index: Int, instructions: List<B
     }
 }
 
+fun MutableMethodImplementation.replaceInstructions(index: Int, instructions: List<BuilderInstruction>) {
+    for (i in instructions.lastIndex downTo 0) {
+        this.replaceInstruction(index + i, instructions[i])
+    }
+}
+
+fun MutableMethodImplementation.removeInstructions(index: Int, count: Int) {
+    for (i in count downTo 0) {
+        this.removeInstruction(index + i)
+    }
+}
+
 /**
  * Compare a method to another, considering constructors and parameters.
  * @param otherMethod The method to compare against.
@@ -66,13 +78,28 @@ internal fun Method.clone(
 }
 
 /**
- * Add smali instructions to the method.
- * @param index The index to insert the instructions at.
+ * Add a smali instruction to the method.
+ * @param index The index to insert the instruction at.
  * @param instruction The smali instruction to add.
  */
 fun MutableMethod.addInstruction(index: Int, instruction: String) =
     this.implementation!!.addInstruction(index, instruction.toInstruction(this))
 
+/**
+ * Replace a smali instruction within the method.
+ * @param index The index to replace the instruction at.
+ * @param instruction The smali instruction to place.
+ */
+fun MutableMethod.replaceInstruction(index: Int, instruction: String) =
+    this.implementation!!.replaceInstruction(index, instruction.toInstruction(this))
+
+/**
+ * Remove a smali instruction within the method.
+ * @param index The index to delete the instruction at.
+ */
+fun MutableMethod.removeInstruction(index: Int) =
+    this.implementation!!.removeInstruction(index)
+
 /**
  * Add smali instructions to the method.
  * @param index The index to insert the instructions at.
@@ -81,6 +108,22 @@ fun MutableMethod.addInstruction(index: Int, instruction: String) =
 fun MutableMethod.addInstructions(index: Int, instructions: String) =
     this.implementation!!.addInstructions(index, instructions.toInstructions(this))
 
+/**
+ * Replace smali instructions within the method.
+ * @param index The index to replace the instructions at.
+ * @param instructions The smali instructions to place.
+ */
+fun MutableMethod.replaceInstructions(index: Int, instructions: String) =
+    this.implementation!!.replaceInstructions(index, instructions.toInstructions(this))
+
+/**
+ * Remove smali instructions from the method.
+ * @param index The index to remove the instructions at.
+ * @param count The amount of instructions to remove.
+ */
+fun MutableMethod.removeInstructions(index: Int, count: Int) =
+    this.implementation!!.removeInstructions(index, count)
+
 /**
  * Clones the method.
  * @param registerCount This parameter allows you to change the register count of the method.
@@ -108,4 +151,4 @@ internal fun parametersEqual(
 internal val nullOutputStream: OutputStream =
     object : OutputStream() {
         override fun write(b: Int) {}
-    }
+    }

src/main/kotlin/app/revanced/patcher/logging/Logger.kt

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

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

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