chore(release): 1.7.1 [skip ci]

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

CHANGELOG.md

@@ -1,3 +1,162 @@
+## [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)
+
+
+### Bug Fixes
+
+* remove javadoc jar (also trigger release) ([56f6ca3](https://github.com/revanced/revanced-patcher/commit/56f6ca38919b522c0d5558eabffa4aee41cc0b0b))
+
+## [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,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.
-            // Instead, you should set them in:
-            // 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!
+            username = githubUsername
+            password = githubPassword
         }
     }
 }
 
 dependencies {
-    implementation(kotlin("stdlib"))
-
-    api("xpp3:xpp3:1.1.4c")
-    api("org.apktool:apktool-lib:2.6.1")
-    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 {
@@ -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
+version = 1.7.1

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,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 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(
-    val internalClasses: MutableList<ClassDef>,
-    val resourceCacheDirectory: String
+data class PatcherData(
+    internal val internalClasses: MutableList<ClassDef>,
+    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

@@ -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) {
-                        if (instruction.opcode != Opcode.CONST_STRING) continue
+                for (instruction in method.implementation!!.instructions) {
+                    if (instruction.opcode != Opcode.CONST_STRING) continue
 
-                        val string = ((instruction as Instruction21c).reference as StringReference).string
-                        val i = stringsList.indexOfFirst { it == string }
-                        if (i != -1) stringsList.removeAt(i)
-                    }
-
-                    if (stringsList.isNotEmpty()) return null
+                    val string = ((instruction as Instruction21c).reference as StringReference).string
+                    val i = stringsList.indexOfFirst { it == string }
+                    if (i != -1) stringsList.removeAt(i)
                 }
+
+                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 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;
-.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.