chore(release): 1.7.2 [skip ci]

## [1.7.2](https://github.com/revanced/revanced-patcher/compare/v1.7.1...v1.7.2) (2022-06-22)

### Bug Fixes

* add execute permission to `./gradlew` file ([#46](https://github.com/revanced/revanced-patcher/issues/46)) ([34f607a](34f607aa24))

.github/workflows/release.yml

@@ -28,8 +28,6 @@ jobs:
         uses: actions/setup-node@v2
         with:
           node-version: "lts/*"
-      - name: Make gradlew executable
-        run: chmod +x gradlew
       - name: Build with Gradle
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

@@ -1,3 +1,107 @@
+## [1.7.2](https://github.com/revanced/revanced-patcher/compare/v1.7.1...v1.7.2) (2022-06-22)
+
+
+### Bug Fixes
+
+* add execute permission to `./gradlew` file ([#46](https://github.com/revanced/revanced-patcher/issues/46)) ([34f607a](https://github.com/revanced/revanced-patcher/commit/34f607aa24d89a777d906cc887203f343ce3fd07))
+
+## [1.7.1](https://github.com/revanced/revanced-patcher/compare/v1.7.0...v1.7.1) (2022-06-22)
+
+
+### Reverts
+
+* revert "feat: use of `java.util.logging.Logger`" ([e8488b3](https://github.com/revanced/revanced-patcher/commit/e8488b3e86e0132011824f8ecba29e64f8db0573))
+
+# [1.7.0](https://github.com/revanced/revanced-patcher/compare/v1.6.0...v1.7.0) (2022-06-22)
+
+
+### Features
+
+* migrate logger to `slf4j` ([8f66f9f](https://github.com/revanced/revanced-patcher/commit/8f66f9f606a785ac947b0e553822877f211d82df))
+
+# [1.6.0](https://github.com/revanced/revanced-patcher/compare/v1.5.0...v1.6.0) (2022-06-22)
+
+
+### Features
+
+* use of `java.util.logging.Logger` ([9c39c9e](https://github.com/revanced/revanced-patcher/commit/9c39c9efdb5d48ddaffce7f711c275e732b0b2d9))
+
+# [1.5.0](https://github.com/revanced/revanced-patcher/compare/v1.4.0...v1.5.0) (2022-06-22)
+
+
+### Features
+
+* use streams to write the dex files ([64bae88](https://github.com/revanced/revanced-patcher/commit/64bae884dcb72550a3218e149f3ca0fd0ca03aaf))
+
+# [1.4.0](https://github.com/revanced/revanced-patcher/compare/v1.3.4...v1.4.0) (2022-06-22)
+
+
+### Features
+
+* return a `File` instance instead of `ExtFile` ([68174bb](https://github.com/revanced/revanced-patcher/commit/68174bbd6b4df47a91b610c2b97dbae55b594163))
+
+## [1.3.4](https://github.com/revanced/revanced-patcher/compare/v1.3.3...v1.3.4) (2022-06-21)
+
+
+### Bug Fixes
+
+* `String.toInstructions` defaulting `forStaticMethod` to `false` ([5a2f02b](https://github.com/revanced/revanced-patcher/commit/5a2f02b97dcde95dbe901fa68cca6c6c0219cb82)), closes [revanced/revanced-patches#46](https://github.com/revanced/revanced-patches/issues/46)
+
+## [1.3.3](https://github.com/revanced/revanced-patcher/compare/v1.3.2...v1.3.3) (2022-06-21)
+
+
+### Bug Fixes
+
+* add docs (trigger release) ([6628b78](https://github.com/revanced/revanced-patcher/commit/6628b7870fc052da40be0d50a7e2b0b6c57743cc))
+
+
+### Reverts
+
+* propagate dependencies ([365e1d7](https://github.com/revanced/revanced-patcher/commit/365e1d7a4507b918a4c8170ce2c88f6c8ff1d474))
+
+## [1.3.2](https://github.com/revanced/revanced-patcher/compare/v1.3.1...v1.3.2) (2022-06-21)
+
+
+### Bug Fixes
+
+* return resourceFile to caller ([1f75777](https://github.com/revanced/revanced-patcher/commit/1f75777cf985bf08483033ec541937d3e733347b))
+
+## [1.3.1](https://github.com/revanced/revanced-patcher/compare/v1.3.0...v1.3.1) (2022-06-21)
+
+
+### Bug Fixes
+
+* `InlineSmaliCompiler.compile` using 0 registers instead of 1 by default ([835a421](https://github.com/revanced/revanced-patcher/commit/835a421cc0588b92c2995e9d74727069d14b1750))
+
+# [1.3.0](https://github.com/revanced/revanced-patcher/compare/v1.2.9...v1.3.0) (2022-06-20)
+
+
+### Features
+
+* `parametersCount` for `InlineSmaliCompiler` instead of `parameters` ([ad6c5c8](https://github.com/revanced/revanced-patcher/commit/ad6c5c827389d10eae473dc66557a699df8c3280))
+* simplify adding instructions ([e47b67d](https://github.com/revanced/revanced-patcher/commit/e47b67d7ec521f288644afb89baf4146dc9bc87d))
+
+## [1.2.9](https://github.com/revanced/revanced-patcher/compare/v1.2.8...v1.2.9) (2022-06-20)
+
+
+### Bug Fixes
+
+* update apktool ([ab866bb](https://github.com/revanced/revanced-patcher/commit/ab866bb8ef4792d8f2a51edc79e687b5b636c621))
+
+## [1.2.8](https://github.com/revanced/revanced-patcher/compare/v1.2.7...v1.2.8) (2022-06-18)
+
+
+### Bug Fixes
+
+* update apktool ([051afd9](https://github.com/revanced/revanced-patcher/commit/051afd98d065f71556392139d77c20b4c2dc7dd1))
+
+## [1.2.7](https://github.com/revanced/revanced-patcher/compare/v1.2.6...v1.2.7) (2022-06-18)
+
+
+### Bug Fixes
+
+* version not working with apktool due to cache ([03f5ee0](https://github.com/revanced/revanced-patcher/commit/03f5ee088b1b96b88cb7aeb323443b6209a13950))
+
 ## [1.2.6](https://github.com/revanced/revanced-patcher/compare/v1.2.5...v1.2.6) (2022-06-18)
 
 

build.gradle.kts

@@ -21,15 +21,13 @@ repositories {
 }
 
 dependencies {
-    implementation(kotlin("stdlib"))
-
-    api("xpp3:xpp3:1.1.4c")
-    api("org.apktool:apktool-lib:2.6.2-SNAPSHOT")
-    api("app.revanced:multidexlib2:2.5.2.r2")
-    api("org.smali:smali:2.5.2")
+    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")
 
     testImplementation(kotlin("test"))
-    implementation(kotlin("reflect"))}
+}
 
 tasks {
     test {

gradle.properties

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

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

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

@@ -42,13 +42,18 @@ val NAMER = BasicDexFileNamer()
  * @param options The options for the patcher.
  */
 class Patcher(private val options: PatcherOptions) {
-    val data: PatcherData
+    private val logger = options.logger
     private val opcodes: Opcodes
 
+    val data: PatcherData
+
     init {
         val extInputFile = ExtFile(options.inputFile)
         val outDir = File(options.resourceCacheDirectory)
-        if (outDir.exists()) outDir.deleteRecursively()
+        if (outDir.exists()) {
+            logger.info("Deleting existing resource cache directory")
+            outDir.deleteRecursively()
+        }
         outDir.mkdirs()
 
         val androlib = Androlib(BuildOptions().also { it.setBuildOptions(options) })
@@ -57,6 +62,8 @@ class Patcher(private val options: PatcherOptions) {
         val packageMetadata = PackageMetadata()
 
         if (options.patchResources) {
+            logger.info("Decoding resources using Androlib, this may take a long time...")
+
             // decode resources to cache directory
             androlib.decodeManifestWithResources(extInputFile, outDir, resourceTable)
             androlib.decodeResourcesFull(extInputFile, outDir, resourceTable)
@@ -71,6 +78,8 @@ class Patcher(private val options: PatcherOptions) {
             }
 
         } else {
+            logger.info("Decoding resources manually because resource decoding is disabled!")
+
             // create decoder for the resource table
             val decoder = ResAttrDecoder()
             decoder.currentPackage = ResPackage(resourceTable, 0, null)
@@ -94,6 +103,7 @@ class Patcher(private val options: PatcherOptions) {
         packageMetadata.metaInfo.sdkInfo = resourceTable.sdkInfo
 
         // 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
@@ -111,9 +121,13 @@ class Patcher(private val options: PatcherOptions) {
      * @param throwOnDuplicates If this is set to true, the patcher will throw an exception if a duplicate class has been found.
      */
     fun addFiles(
-        files: List<File>, allowedOverwrites: Iterable<String> = emptyList(), throwOnDuplicates: Boolean = false
+        files: List<File>,
+        allowedOverwrites: Iterable<String> = emptyList(),
+        throwOnDuplicates: Boolean = false,
+        callback: (File) -> Unit
     ) {
         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) {
@@ -123,10 +137,16 @@ class Patcher(private val options: PatcherOptions) {
                     val (_, idx) = e
                     if (allowedOverwrites.contains(classDef.type)) {
                         data.bytecodeData.classes.internalClasses[idx] = classDef
+                        modified = true
                     }
                     continue
                 }
                 data.bytecodeData.classes.internalClasses.add(classDef)
+                modified = true
+            }
+            if (modified) {
+                logger.trace("Added file ${file.name}")
+                callback(file)
             }
         }
     }
@@ -137,8 +157,10 @@ class Patcher(private val options: PatcherOptions) {
     fun save(): PatcherResult {
         val packageMetadata = data.packageMetadata
         val metaInfo = packageMetadata.metaInfo
+        var resourceFile: File? = null
 
         if (options.patchResources) {
+            logger.info("Patching resources")
             val cacheDirectory = ExtFile(options.resourceCacheDirectory)
 
             val androlibResources = AndrolibResources().also { resources ->
@@ -172,16 +194,16 @@ class Patcher(private val options: PatcherOptions) {
                 )
             }.toTypedArray()
 
+            logger.trace("Packaging using aapt")
             androlibResources.aaptPackage(
                 aaptFile, manifestFile, resDirectory, null,
                 null, includedFiles
             )
 
-            // write packaged resources to cache directory
-            ExtFile(aaptFile).directory.copyToDir(cacheDirectory.resolve("build/"))
-
+            resourceFile = aaptFile
         }
 
+        logger.trace("Creating new dex file")
         val newDexFile = object : DexFile {
             override fun getClasses(): Set<ClassDef> {
                 data.bytecodeData.classes.applyProxies()
@@ -193,7 +215,8 @@ class Patcher(private val options: PatcherOptions) {
             }
         }
 
-        // write dex modified files
+        // write modified dex files
+        logger.info("Writing modified dex files")
         val dexFiles = mutableMapOf<String, MemoryDataStore>()
         MultiDexIO.writeDexFile(
             true, -1, // core count
@@ -202,9 +225,10 @@ class Patcher(private val options: PatcherOptions) {
 
         return PatcherResult(
             dexFiles.map {
-                app.revanced.patcher.util.dex.DexFile(it.key, it.value)
+                app.revanced.patcher.util.dex.DexFile(it.key, it.value.readAt(0))
             },
-            metaInfo.doNotCompress.toList()
+            metaInfo.doNotCompress.toList(),
+            resourceFile
         )
     }
 
@@ -223,12 +247,17 @@ 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)) return PatchResultSuccess()
+        if (appliedPatches.contains(patchName)) {
+            logger.trace("Skipping patch $patchName because it has already been applied")
+            return PatchResultSuccess()
+        }
         appliedPatches.add(patchName)
 
         // recursively apply all dependency patches
@@ -246,7 +275,9 @@ class Patcher(private val options: PatcherOptions) {
 
         // if the current patch is a resource patch but resource patching is disabled, return an error
         val isResourcePatch = patchInstance is ResourcePatch
-        if (!options.patchResources && isResourcePatch) return PatchResultError("$patchName is a resource patch, but resource patching is disabled.")
+        if (!options.patchResources && isResourcePatch) {
+            return PatchResultError("$patchName is a resource patch, but resource patching is disabled.")
+        }
 
         // TODO: find a solution for this
         val data = if (isResourcePatch) {
@@ -258,6 +289,7 @@ class Patcher(private val options: PatcherOptions) {
             data.bytecodeData
         }
 
+        logger.trace("Executing patch $patchName of type: ${if (isResourcePatch) "resource" else "bytecode"}")
         return try {
             patchInstance.execute(data)
         } catch (e: Exception) {
@@ -273,23 +305,23 @@ class Patcher(private val options: PatcherOptions) {
      * If the [Patch] failed to apply, an Exception will always be returned to the wrapping Result object.
      */
     fun applyPatches(
-        stopOnError: Boolean = false, callback: (String) -> Unit = {}
+        stopOnError: Boolean = false,
+        callback: (Class<out Patch<Data>>, Boolean) -> Unit = { _, _ -> }
     ): Map<String, Result<PatchResultSuccess>> {
+        logger.trace("Applying all patches")
         val appliedPatches = mutableListOf<String>()
 
         return buildMap {
             for (patch in data.patches) {
                 val result = applyPatch(patch, appliedPatches)
 
-                val name = patch.patchName
-                callback(name)
-
-                this[name] = if (result.isSuccess()) {
+                this[patch.patchName] = if (result.isSuccess()) {
                     Result.success(result.success()!!)
                 } else {
                     Result.failure(result.error()!!)
                 }
 
+                callback(patch, result.isSuccess())
                 if (stopOnError && result.isError()) break
             }
         }

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

@@ -3,17 +3,19 @@ package app.revanced.patcher
 import java.io.File
 
 /**
- * Options for a patcher.
+ * Options for the [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.
+ * @param logger Custom logger implementation for the [Patcher].
  */
 data class PatcherOptions(
     internal val inputFile: File,
     internal val resourceCacheDirectory: String,
     internal val patchResources: Boolean = false,
     internal val aaptPath: String = "",
-    internal val frameworkFolderLocation: String? = null
+    internal val frameworkFolderLocation: String? = null,
+    internal val logger: PatchLogger = NoopPatchLogger
 )

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

@@ -1,13 +1,16 @@
 package app.revanced.patcher
 
 import app.revanced.patcher.util.dex.DexFile
+import java.io.File
 
 /**
  * The result of a patcher.
  * @param dexFiles The patched dex files.
  * @param doNotCompress List of relative paths to files to exclude from compressing.
+ * @param resourceFile File containing resources that need to be extracted into the APK.
  */
 data class PatcherResult(
     val dexFiles: List<DexFile>,
-    val doNotCompress: List<String>? = null
+    val doNotCompress: List<String>? = null,
+    val resourceFile: File?
 )

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

@@ -1,6 +1,9 @@
 package app.revanced.patcher.extensions
 
+import app.revanced.patcher.util.proxy.mutableTypes.MutableMethod
 import app.revanced.patcher.util.proxy.mutableTypes.MutableMethod.Companion.toMutable
+import app.revanced.patcher.util.smali.toInstruction
+import app.revanced.patcher.util.smali.toInstructions
 import org.jf.dexlib2.AccessFlags
 import org.jf.dexlib2.builder.BuilderInstruction
 import org.jf.dexlib2.builder.MutableMethodImplementation
@@ -62,6 +65,22 @@ internal fun Method.clone(
     )
 }
 
+/**
+ * Add smali instructions to the method.
+ * @param index The index to insert the instructions at.
+ * @param instruction The smali instruction to add.
+ */
+fun MutableMethod.addInstruction(index: Int, instruction: String) =
+    this.implementation!!.addInstruction(index, instruction.toInstruction(this))
+
+/**
+ * Add smali instructions to the method.
+ * @param index The index to insert the instructions at.
+ * @param instructions The smali instructions to add.
+ */
+fun MutableMethod.addInstructions(index: Int, instructions: String) =
+    this.implementation!!.addInstructions(index, instructions.toInstructions(this))
+
 /**
  * Clones the method.
  * @param registerCount This parameter allows you to change the register count of the method.

src/main/kotlin/app/revanced/patcher/patch/implementation/BytecodePatch.kt

@@ -9,5 +9,5 @@ import app.revanced.patcher.signature.implementation.method.MethodSignature
  * @param signatures A list of [MethodSignature] this patch relies on.
  */
 abstract class BytecodePatch(
-    val signatures: Iterable<MethodSignature>
+    internal val signatures: Iterable<MethodSignature>
 ) : Patch<BytecodeData>()

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

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

src/main/kotlin/app/revanced/patcher/util/smali/InlineSmaliCompiler.kt

@@ -3,8 +3,10 @@ package app.revanced.patcher.util.smali
 import org.antlr.runtime.CommonTokenStream
 import org.antlr.runtime.TokenSource
 import org.antlr.runtime.tree.CommonTreeNodeStream
+import org.jf.dexlib2.AccessFlags
 import org.jf.dexlib2.Opcodes
 import org.jf.dexlib2.builder.BuilderInstruction
+import org.jf.dexlib2.iface.Method
 import org.jf.dexlib2.writer.builder.DexBuilder
 import org.jf.smali.LexerErrorInterface
 import org.jf.smali.smaliFlexLexer
@@ -13,12 +15,12 @@ import org.jf.smali.smaliTreeWalker
 import java.io.InputStreamReader
 
 private const val METHOD_TEMPLATE = """
-.class LInlineCompiler;
-.super Ljava/lang/Object;
-.method %s dummyMethod(%s)V
-    .registers %d
-    %s
-.end method
+    .class LInlineCompiler;
+    .super Ljava/lang/Object;
+    .method %s dummyMethod(%s)V
+        .registers %d
+        %s
+    .end method
 """
 
 class InlineSmaliCompiler {
@@ -32,13 +34,11 @@ class InlineSmaliCompiler {
          * be messed up and results in broken Dalvik bytecode.
          * FIXME: Fix the above issue. When this is fixed, add the proper conversions in [InstructionConverter].
          */
-        fun compileMethodInstructions(
-            instructions: String,
-            parameters: String,
-            registers: Int,
-            forStaticMethod: Boolean
+        fun compile(
+            instructions: String, parameters: String, registers: Int, forStaticMethod: Boolean
         ): List<BuilderInstruction> {
-            val input = METHOD_TEMPLATE.format(if (forStaticMethod) "static" else "", parameters, registers, instructions)
+            val input =
+                METHOD_TEMPLATE.format(if (forStaticMethod) "static" else "", parameters, registers, instructions)
             val reader = InputStreamReader(input.byteInputStream())
             val lexer: LexerErrorInterface = smaliFlexLexer(reader, 15)
             val tokens = CommonTokenStream(lexer as TokenSource)
@@ -59,8 +59,20 @@ class InlineSmaliCompiler {
     }
 }
 
-fun String.toInstructions(parameters: String = "", registers: Int = 1, forStaticMethod: Boolean = true) =
-    InlineSmaliCompiler.compileMethodInstructions(this, parameters, registers, forStaticMethod)
+/**
+ * Compile lines of Smali code to a list of instructions.
+ * @param templateMethod The method to compile the instructions against.
+ * @returns A list of instructions.
+ */
+fun String.toInstructions(templateMethod: Method? = null) = InlineSmaliCompiler.compile(this,
+    templateMethod?.parameters?.joinToString("") { it } ?: "",
+    templateMethod?.implementation?.registerCount ?: 1,
+    templateMethod?.let { AccessFlags.STATIC.isSet(it.accessFlags) } ?: true
+)
 
-fun String.toInstruction(parameters: String = "", registers: Int = 1, forStaticMethod: Boolean = true) =
-    this.toInstructions(parameters, registers, forStaticMethod).first()
+/**
+ * Compile a line of Smali code to an instruction.
+ * @param templateMethod The method to compile the instructions against.
+ * @return The instruction.
+ */
+fun String.toInstruction(templateMethod: Method? = null) = this.toInstructions(templateMethod).first()

src/test/kotlin/app/revanced/patcher/usage/bytecode/patch/ExampleBytecodePatch.kt

@@ -15,7 +15,6 @@ import app.revanced.patcher.usage.resource.annotation.ExampleResourceCompatibili
 import app.revanced.patcher.util.proxy.mutableTypes.MutableField.Companion.toMutable
 import app.revanced.patcher.util.proxy.mutableTypes.MutableMethod.Companion.toMutable
 import app.revanced.patcher.util.smali.toInstruction
-import app.revanced.patcher.util.smali.toInstructions
 import com.google.common.collect.ImmutableList
 import org.jf.dexlib2.AccessFlags
 import org.jf.dexlib2.Format
@@ -47,7 +46,7 @@ class ExampleBytecodePatch : BytecodePatch(
     // You can treat it as a constructor
     override fun execute(data: BytecodeData): PatchResult {
         // Get the resolved method for the signature from the resolver cache
-        val result = signatures.first().result!!
+        val result = ExampleSignature.result!!
 
         // Get the implementation for the resolved method
         val implementation = result.method.implementation!!
@@ -126,8 +125,8 @@ class ExampleBytecodePatch : BytecodePatch(
                         invoke-static { }, LTestClass;->returnHello()Ljava/lang/String;
                         move-result-object v1
                         invoke-virtual { v0, v1 }, Ljava/io/PrintStream;->println(Ljava/lang/String;)V
-                    """.trimIndent().toInstructions()
-        implementation.addInstructions(startIndex + 2, instructions)
+                    """
+        result.method.addInstructions(startIndex + 2, instructions)
 
         // Finally, tell the patcher that this patch was a success.
         // You can also return PatchResultError with a message.