chore(release): 1.6.0 [skip ci]

# [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](9c39c9efdb))

build.gradle.kts

@@ -1,38 +1,32 @@
 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!
         }
     }
 }
 
 dependencies {
-    implementation(kotlin("stdlib"))
+    implementation("xpp3:xpp3:1.1.4c")
-
+    implementation("app.revanced:multidexlib2:2.5.2.r2")
-    api("xpp3:xpp3:1.1.4c")
+    implementation("org.smali:smali:2.5.2")
-    api("org.apktool:apktool-lib:2.6.1")
+    implementation("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"))
-    implementation(kotlin("reflect"))
 }
 
 tasks {
@@ -46,14 +40,10 @@ tasks {
 
 java {
     withSourcesJar()
-    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,13 +52,10 @@ publishing {
                     password = System.getenv("GITHUB_TOKEN")
                 }
             }
-        } else {
-            mavenLocal()
-        }
     }
     publications {
         register<MavenPublication>("gpr") {
             from(components["java"])
         }
     }
-}
+}

gradle.properties

@@ -1,2 +1,2 @@
 kotlin.code.style = official
-version = 1.0.0-dev.18
+version = 1.6.0

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,17 @@
+package app.revanced.patcher
+
+import app.revanced.patcher.util.dex.DexFile
+import brut.directory.ExtFile
+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 resourceFile: File?
+)

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/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/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/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/signature/implementation/method/resolver/MethodSignatureResolver.kt

@@ -3,6 +3,7 @@ package app.revanced.patcher.signature.implementation.method.resolver
 import app.revanced.patcher.data.PatcherData
 import app.revanced.patcher.data.implementation.proxy
 import app.revanced.patcher.extensions.MethodSignatureExtensions.fuzzyThreshold
+import app.revanced.patcher.extensions.MethodSignatureExtensions.name
 import app.revanced.patcher.extensions.parametersEqual
 import app.revanced.patcher.signature.implementation.method.MethodSignature
 import org.jf.dexlib2.Opcode
@@ -11,37 +12,25 @@ import org.jf.dexlib2.iface.Method
 import org.jf.dexlib2.iface.instruction.Instruction
 import org.jf.dexlib2.iface.instruction.formats.Instruction21c
 import org.jf.dexlib2.iface.reference.StringReference
+import java.util.logging.Logger
 
 internal class MethodSignatureResolver(
     private val classes: List<ClassDef>,
     private val methodSignatures: Iterable<MethodSignature>
 ) {
-    fun resolve(patcherData: PatcherData) {
-        for (signature in methodSignatures) {
-            for (classDef in classes) {
-                for (method in classDef.methods) {
-                    val patternScanData = compareSignatureToMethod(signature, method) ?: continue
-
-                    // create class proxy, in case a patch needs mutability
-                    val classProxy = patcherData.bytecodeData.proxy(classDef)
-                    signature.result = SignatureResolverResult(
-                        classProxy,
-                        patternScanData,
-                        method,
-                    )
-                }
-            }
-        }
-    }
-
     // These functions do not require the constructor values, so they can be static.
     companion object {
+        private val LOGGER: Logger = Logger.getLogger(::MethodSignatureResolver.name)
+
         fun resolveFromProxy(
             classProxy: app.revanced.patcher.util.proxy.ClassProxy,
             signature: MethodSignature
         ): SignatureResolverResult? {
             for (method in classProxy.immutableClass.methods) {
                 val result = compareSignatureToMethod(signature, method) ?: continue
+
+                LOGGER.fine("${signature.name} match to ${method.definingClass}->${method.name}")
+
                 return SignatureResolverResult(
                     classProxy,
                     result,
@@ -76,19 +65,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) {
@@ -158,6 +145,28 @@ internal class MethodSignatureResolver(
             }
         }
     }
+
+    fun resolve(patcherData: PatcherData) {
+        for (signature in methodSignatures) {
+            val signatureName = signature.name
+            LOGGER.fine("Resolve $signatureName")
+            for (classDef in classes) {
+                for (method in classDef.methods) {
+                    val patternScanData = compareSignatureToMethod(signature, method) ?: continue
+
+                    LOGGER.fine("$signatureName match to ${method.definingClass}->${method.name}")
+
+                    // create class proxy, in case a patch needs mutability
+                    val classProxy = patcherData.bytecodeData.proxy(classDef)
+                    signature.result = SignatureResolverResult(
+                        classProxy,
+                        patternScanData,
+                        method,
+                    )
+                }
+            }
+        }
+    }
 }
 
 private operator fun ClassDef.component1() = this

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

@@ -0,0 +1,10 @@
+package app.revanced.patcher.util.dex
+
+import java.io.InputStream
+
+/**
+ * Wrapper for dex files.
+ * @param name The original name of the dex file.
+ * @param dexFileInputStream The dex file as [InputStream].
+ */
+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;
+    .class LInlineCompiler;
-.super Ljava/lang/Object;
+    .super Ljava/lang/Object;
-.method %s dummyMethod(%s)V
+    .method %s dummyMethod(%s)V
-    .registers %d
+        .registers %d
-    %s
+        %s
-.end method
+    .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(
+        fun compile(
-            instructions: String,
+            instructions: String, parameters: String, registers: Int, forStaticMethod: Boolean
-            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.