chore(release): 1.8.0 [skip ci]

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

### Features

* logging class ([caf2745](caf2745805))

.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,52 @@
+# [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)
+
+
+### 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)
 
 

build.gradle.kts

@@ -21,13 +21,10 @@ repositories {
 }
 
 dependencies {
-    implementation(kotlin("stdlib"))
+    implementation("xpp3:xpp3:1.1.4c")
-    implementation(kotlin("reflect"))
+    implementation("app.revanced:multidexlib2:2.5.2.r2")
-
+    implementation("org.smali:smali:2.5.2")
-    api("xpp3:xpp3:1.1.4c")
+    implementation("org.apktool:apktool-lib:2.6.5-SNAPSHOT")
-    api("app.revanced:multidexlib2:2.5.2.r2")
-    api("org.smali:smali:2.5.2")
-    api("org.apktool:apktool-lib:2.6.5-SNAPSHOT")
 
     testImplementation(kotlin("test"))
 }

gradle.properties

@@ -1,2 +1,2 @@
 kotlin.code.style = official
-version = 1.3.4
+version = 1.8.0

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 AndroidManifest.xml manually because resource patching is disabled")
+
             // create decoder for the resource table
             val decoder = ResAttrDecoder()
             decoder.currentPackage = ResPackage(resourceTable, 0, null)
@@ -93,6 +102,8 @@ class Patcher(private val options: PatcherOptions) {
         packageMetadata.metaInfo.versionInfo = resourceTable.versionInfo
         packageMetadata.metaInfo.sdkInfo = resourceTable.sdkInfo
 
+        logger.info("Reading input as dex file")
+
         // read dex files
         val dexFile = MultiDexIO.readDexFile(true, options.inputFile, NAMER, null, null)
         // get the opcodes
@@ -111,22 +122,35 @@ 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) {
             for (classDef in MultiDexIO.readDexFile(true, file, NAMER, null, null).classes) {
-                val e = data.bytecodeData.classes.internalClasses.findIndexed { it.type == classDef.type }
+                val type = classDef.type
-                if (e != null) {
+
-                    if (throwOnDuplicates) {
+                val existingClass = data.bytecodeData.classes.internalClasses.findIndexed { it.type == type }
-                        throw Exception("Class ${classDef.type} has already been added to the patcher.")
+                if (existingClass == null) {
-                    }
+                    if (throwOnDuplicates) throw Exception("Class $type has already been added to the patcher")
-                    val (_, idx) = e
+
-                    if (allowedOverwrites.contains(classDef.type)) {
+                    logger.trace("Merging $type")
-                        data.bytecodeData.classes.internalClasses[idx] = classDef
+                    data.bytecodeData.classes.internalClasses.add(classDef)
-                    }
+
+                    callback(file)
+
                     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
+
+                callback(file)
             }
         }
     }
@@ -137,9 +161,10 @@ class Patcher(private val options: PatcherOptions) {
     fun save(): PatcherResult {
         val packageMetadata = data.packageMetadata
         val metaInfo = packageMetadata.metaInfo
-        var resourceFile: ExtFile? = null
+        var resourceFile: File? = null
 
         if (options.patchResources) {
+            logger.info("Patching resources")
             val cacheDirectory = ExtFile(options.resourceCacheDirectory)
 
             val androlibResources = AndrolibResources().also { resources ->
@@ -168,19 +193,19 @@ class Patcher(private val options: PatcherOptions) {
             val resDirectory = cacheDirectory.resolve("res")
             val includedFiles = metaInfo.usesFramework.ids.map { id ->
                 androlibResources.getFrameworkApk(
-                    id,
+                    id, metaInfo.usesFramework.tag
-                    metaInfo.usesFramework.tag
                 )
             }.toTypedArray()
 
+            logger.trace("Packaging using aapt")
             androlibResources.aaptPackage(
-                aaptFile, manifestFile, resDirectory, null,
+                aaptFile, manifestFile, resDirectory, null, null, includedFiles
-                null, includedFiles
             )
 
-            resourceFile = ExtFile(aaptFile)
+            resourceFile = aaptFile
         }
 
+        logger.trace("Creating new dex file")
         val newDexFile = object : DexFile {
             override fun getClasses(): Set<ClassDef> {
                 data.bytecodeData.classes.applyProxies()
@@ -192,7 +217,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
@@ -201,10 +227,8 @@ 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(), resourceFile
-            metaInfo.doNotCompress.toList(),
-            resourceFile
         )
     }
 
@@ -227,8 +251,14 @@ class Patcher(private val options: PatcherOptions) {
     ): 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 +276,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 +290,8 @@ 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 +307,22 @@ 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
+                this[patch.patchName] = if (result.isSuccess()) {
-                callback(name)
-
-                this[name] = 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

@@ -1,19 +1,23 @@
 package app.revanced.patcher
 
+import app.revanced.patcher.logging.impl.NopLogger
+import app.revanced.patcher.logging.Logger
 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: Logger = NopLogger
 )

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

@@ -1,16 +1,16 @@
 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 ExtFile containing resources that need to be extracted into the APK.
+ * @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: ExtFile?
+    val resourceFile: File?
 )

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

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 name The original name of the dex file.
- * @param memoryDataStore The data store for 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)