chore(release): 1.11.0 [skip ci]

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

### Features

* improve logging ([df85fa3](df85fa37ef))

CHANGELOG.md

@@ -1,3 +1,93 @@
+# [1.11.0](https://github.com/revanced/revanced-cli/compare/v1.10.2...v1.11.0) (2022-06-23)
+
+
+### Features
+
+* improve logging ([df85fa3](https://github.com/revanced/revanced-cli/commit/df85fa37ef067681a027e6fe9212c8a065d4981b))
+
+## [1.10.2](https://github.com/revanced/revanced-cli/compare/v1.10.1...v1.10.2) (2022-06-22)
+
+
+### Bug Fixes
+
+* keystore file not found exception ([#57](https://github.com/revanced/revanced-cli/issues/57)) ([5b8537e](https://github.com/revanced/revanced-cli/commit/5b8537e6b7922f1b44058c3a4fc2f56cb4e15e89))
+
+## [1.10.1](https://github.com/revanced/revanced-cli/compare/v1.10.0...v1.10.1) (2022-06-22)
+
+
+### Bug Fixes
+
+* show actual version in CLI ([1dcdbc9](https://github.com/revanced/revanced-cli/commit/1dcdbc9fe9e3ad2fe232ad3baa76d186817532a4))
+
+# [1.10.0](https://github.com/revanced/revanced-cli/compare/v1.9.3...v1.10.0) (2022-06-22)
+
+
+### Bug Fixes
+
+* add callback for addFiles ([87ffaa4](https://github.com/revanced/revanced-cli/commit/87ffaa4bdb25cb85c6ba7195f5d3b13b09a5f912))
+
+
+### Features
+
+* add logging back ([4a23cb6](https://github.com/revanced/revanced-cli/commit/4a23cb69bc385158d47b6ea8d3da54b0566a242c))
+
+## [1.9.3](https://github.com/revanced/revanced-cli/compare/v1.9.2...v1.9.3) (2022-06-22)
+
+
+### Bug Fixes
+
+* use absolute file path for key store ([d335846](https://github.com/revanced/revanced-cli/commit/d335846202b991e130882e9ce0ab268deb2e27ab))
+
+## [1.9.2](https://github.com/revanced/revanced-cli/compare/v1.9.1...v1.9.2) (2022-06-22)
+
+
+### Bug Fixes
+
+* update patcher version ([0df936e](https://github.com/revanced/revanced-cli/commit/0df936e99b01358a88a628af63eebb5ac92cae76))
+
+## [1.9.1](https://github.com/revanced/revanced-cli/compare/v1.9.0...v1.9.1) (2022-06-22)
+
+
+### Bug Fixes
+
+* add back in: option to specify keystore file path ([c94471f](https://github.com/revanced/revanced-cli/commit/c94471f4643e44b2b472ff0d826db0d2743bdc86))
+* remove logger from Signer.kt ([51e091c](https://github.com/revanced/revanced-cli/commit/51e091ce4021418508044029aa5af6aa7d5162a3))
+
+
+### Reverts
+
+* "feat: use of `java.util.logging.Logger`" ([2c8a106](https://github.com/revanced/revanced-cli/commit/2c8a10615192635202ddc137fc02f175c5914d8f))
+
+# [1.9.0](https://github.com/revanced/revanced-cli/compare/v1.8.0...v1.9.0) (2022-06-22)
+
+
+### Features
+
+* migrate logger to `slf4j` ([6c4c192](https://github.com/revanced/revanced-cli/commit/6c4c1924ee9ae75af3449749a6a82b7ae5572129))
+
+# [1.8.0](https://github.com/revanced/revanced-cli/compare/v1.7.1...v1.8.0) (2022-06-22)
+
+
+### Features
+
+* add option to specify keystore file path ([9331594](https://github.com/revanced/revanced-cli/commit/9331594706404df871d170110da753cde5058d02))
+* use of `java.util.logging.Logger` ([07f6bdf](https://github.com/revanced/revanced-cli/commit/07f6bdf33069da4e11fc40090feb726433de703e))
+
+## [1.7.1](https://github.com/revanced/revanced-cli/compare/v1.7.0...v1.7.1) (2022-06-22)
+
+
+### Bug Fixes
+
+* migrate to changes of patcher ([b30c737](https://github.com/revanced/revanced-cli/commit/b30c7375a7ea61184be5dca19062ee74d1f97692))
+* wrong variable inverted ([f694542](https://github.com/revanced/revanced-cli/commit/f694542d64ccb06bfa4d042f26b6b7192d1e912e))
+
+# [1.7.0](https://github.com/revanced/revanced-cli/compare/v1.6.3...v1.7.0) (2022-06-21)
+
+
+### Features
+
+* show description when listing patches ([af32572](https://github.com/revanced/revanced-cli/commit/af32572f29d0f0a45ee5c3e01ba4cf1f91fe2f10))
+
 ## [1.6.3](https://github.com/revanced/revanced-cli/compare/v1.6.2...v1.6.3) (2022-06-21)
 
 

build.gradle.kts

@@ -32,7 +32,7 @@ dependencies {
     implementation(kotlin("stdlib"))
     implementation(kotlin("reflect"))
 
-    implementation("app.revanced:revanced-patcher:1.3.4")
+    implementation("app.revanced:revanced-patcher:1.10.0")
     implementation("info.picocli:picocli:4.6.3")
     implementation("com.android.tools.build:apksig:7.2.1")
     implementation("com.github.revanced:jadb:master-SNAPSHOT") // updated fork

gradle.properties

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

src/main/kotlin/app/revanced/cli/command/MainCommand.kt

@@ -1,8 +1,12 @@
 package app.revanced.cli.command
 
+import app.revanced.cli.logging.impl.DefaultCliLogger
 import app.revanced.cli.patcher.Patcher
+import app.revanced.cli.patcher.logging.impl.PatcherLogger
 import app.revanced.cli.signing.Signing
+import app.revanced.cli.signing.SigningOptions
 import app.revanced.patcher.PatcherOptions
+import app.revanced.patcher.extensions.PatchExtensions.description
 import app.revanced.patcher.extensions.PatchExtensions.patchName
 import app.revanced.patcher.util.patch.implementation.JarPatchBundle
 import app.revanced.utils.adb.Adb
@@ -10,12 +14,20 @@ import picocli.CommandLine.*
 import java.io.File
 import java.nio.file.Files
 
+private class CLIVersionProvider : IVersionProvider {
+    override fun getVersion() = arrayOf(
+        MainCommand::class.java.`package`.implementationVersion ?: "unknown"
+    )
+}
+
 @Command(
     name = "ReVanced-CLI",
-    version = ["1.0.0"],
-    mixinStandardHelpOptions = true
+    mixinStandardHelpOptions = true,
+    versionProvider = CLIVersionProvider::class
 )
 internal object MainCommand : Runnable {
+    val logger = DefaultCliLogger()
+
     @ArgGroup(exclusive = false, multiplicity = "1")
     lateinit var args: Args
 
@@ -60,6 +72,9 @@ internal object MainCommand : Runnable {
         @Option(names = ["--cn"], description = ["Overwrite the default CN for the signed file"])
         var cn = "ReVanced"
 
+        @Option(names = ["--keystore"], description = ["File path to your keystore"])
+        var keystorePath: String? = null
+
         @Option(names = ["-p", "--password"], description = ["Overwrite the default password for the signed file"])
         var password = "ReVanced"
 
@@ -79,7 +94,7 @@ internal object MainCommand : Runnable {
     override fun run() {
         if (args.lArgs?.listOnly == true) {
             for (patchBundlePath in args.patchBundles) for (patch in JarPatchBundle(patchBundlePath).loadPatches()) {
-                println("[available] ${patch.patchName}")
+                logger.info("${patch.patchName}: ${patch.description}")
             }
             return
         }
@@ -88,7 +103,10 @@ internal object MainCommand : Runnable {
 
         val patcher = app.revanced.patcher.Patcher(
             PatcherOptions(
-                args.inputFile, args.cacheDirectory, !args.disableResourcePatching
+                args.inputFile,
+                args.cacheDirectory,
+                !args.disableResourcePatching,
+                logger = PatcherLogger
             )
         )
 
@@ -98,32 +116,31 @@ internal object MainCommand : Runnable {
             Adb(outputFile, patcher.data.packageMetadata.packageName, args.deploy!!, !args.mount)
         }
 
-        val patchedFile = if (args.mount) {
-            File(args.cacheDirectory).resolve("${outputFile.nameWithoutExtension}_raw.apk")
-        } else outputFile
+        val patchedFile = if (args.mount) outputFile
+        else File(args.cacheDirectory).resolve("${outputFile.nameWithoutExtension}_raw.apk")
 
         Patcher.start(patcher, patchedFile)
 
-        println("[aligning & signing]")
-
         if (!args.mount) {
             Signing.start(
                 patchedFile,
                 outputFile,
-                args.cn,
-                args.password,
+                SigningOptions(
+                    args.cn,
+                    args.password,
+                    args.keystorePath ?: outputFile.absoluteFile.parentFile
+                        .resolve("${outputFile.nameWithoutExtension}.keystore")
+                        .name
+                )
             )
         }
 
         if (args.clean) File(args.cacheDirectory).deleteRecursively()
 
-        adb?.let {
-            println("[deploying]")
-            it.deploy()
-        }
+        adb?.deploy()
 
         if (args.clean && args.deploy != null) Files.delete(outputFile.toPath())
 
-        println("[done]")
+        logger.info("Finished")
     }
 }

src/main/kotlin/app/revanced/cli/logging/CliLogger.kt

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

src/main/kotlin/app/revanced/cli/logging/impl/DefaultCliLogger.kt

@@ -0,0 +1,20 @@
+package app.revanced.cli.logging.impl
+
+import app.revanced.cli.command.MainCommand
+import app.revanced.cli.logging.CliLogger
+import java.util.logging.Logger
+
+internal class DefaultCliLogger(
+    private val logger: Logger = Logger.getLogger(MainCommand::javaClass.name)
+) : CliLogger {
+    companion object {
+        init {
+            System.setProperty("java.util.logging.SimpleFormatter.format", "%4\$s: %5\$s %n")
+        }
+    }
+
+    override fun error(msg: String) = logger.severe(msg)
+    override fun info(msg: String) = logger.info(msg)
+    override fun trace(msg: String) = logger.finest(msg)
+    override fun warn(msg: String) = logger.warning(msg)
+}

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

@@ -1,6 +1,7 @@
 package app.revanced.cli.patcher
 
 import app.revanced.cli.command.MainCommand.args
+import app.revanced.cli.command.MainCommand.logger
 import app.revanced.utils.filesystem.ZipFileSystemUtils
 import app.revanced.utils.patcher.addPatchesFiltered
 import app.revanced.utils.patcher.applyPatchesVerbose
@@ -30,12 +31,14 @@ internal object Patcher {
         ZipFileSystemUtils(inputFile, output).use { fileSystem ->
             // replace all dex files
             result.dexFiles.forEach {
-                fileSystem.write(it.name, it.memoryDataStore.data)
+                logger.info("Writing dex file ${it.name}")
+                fileSystem.write(it.name, it.dexFileInputStream.readAllBytes())
             }
 
             // inputFile being null implies resource patching being disabled
             if (inputFile != null) {
                 // write resources
+                logger.info("Writing resources")
                 fileSystem.writeInput()
                 fileSystem.uncompress(*result.doNotCompress!!.toTypedArray())
             }

src/main/kotlin/app/revanced/cli/patcher/logging/impl/PatcherLogger.kt

@@ -0,0 +1,13 @@
+package app.revanced.cli.patcher.logging.impl
+
+import app.revanced.cli.logging.impl.DefaultCliLogger
+import java.util.logging.Logger
+
+internal object PatcherLogger : app.revanced.patcher.logging.Logger{
+    private val logger = DefaultCliLogger(Logger.getLogger(app.revanced.patcher.Patcher::javaClass.name))
+
+    override fun error(msg: String) = logger.error(msg)
+    override fun info(msg: String) = logger.info(msg)
+    override fun warn(msg: String)= logger.warn(msg)
+    override fun trace(msg: String)= logger.trace(msg)
+}

src/main/kotlin/app/revanced/cli/signing/Signing.kt

@@ -1,25 +1,28 @@
 package app.revanced.cli.signing
 
 import app.revanced.cli.command.MainCommand.args
+import app.revanced.cli.command.MainCommand.logger
 import app.revanced.utils.signing.Signer
 import app.revanced.utils.signing.align.ZipAligner
 import java.io.File
 
 object Signing {
-    fun start(inputFile: File, outputFile: File, cn: String, password: String) {
+    fun start(inputFile: File, outputFile: File, signingOptions: SigningOptions) {
         val cacheDirectory = File(args.pArgs!!.cacheDirectory)
         val alignedOutput = cacheDirectory.resolve("${outputFile.nameWithoutExtension}_aligned.apk")
         val signedOutput = cacheDirectory.resolve("${outputFile.nameWithoutExtension}_signed.apk")
 
         // align the inputFile and write to alignedOutput
+        logger.info("Aligning ${inputFile.name}")
         ZipAligner.align(inputFile, alignedOutput)
         // sign the alignedOutput and write to signedOutput
         // the reason is, in case the signer fails
         // it does not damage the output file
-        val keyStore = Signer(cn, password).signApk(alignedOutput, signedOutput)
+        logger.info("Signing ${alignedOutput.name}")
+        Signer(signingOptions).signApk(alignedOutput, signedOutput)
 
-        // afterwards copy over the file and the keystore to the output
+        // afterwards copy over the file to the output
+        logger.info("Copying ${signedOutput.name} to ${outputFile.name}")
         signedOutput.copyTo(outputFile, true)
-        keyStore.copyTo(outputFile.resolveSibling(keyStore.name), true)
     }
 }

src/main/kotlin/app/revanced/cli/signing/SigningOptions.kt

@@ -0,0 +1,7 @@
+package app.revanced.cli.signing
+
+data class SigningOptions(
+    val cn: String,
+    val password: String,
+    val keyStoreFilePath: String
+)

src/main/kotlin/app/revanced/utils/adb/Adb.kt

@@ -1,5 +1,6 @@
 package app.revanced.utils.adb
 
+import app.revanced.cli.command.MainCommand.logger
 import se.vidstige.jadb.JadbConnection
 import se.vidstige.jadb.JadbDevice
 import se.vidstige.jadb.managers.PackageManager
@@ -20,7 +21,7 @@ internal class Adb(
             ?: throw IllegalArgumentException("No such device with name $deviceName")
 
         if (!modeInstall && device.run("su -h", false) != 0)
-            throw IllegalArgumentException("Root required on $deviceName. Deploying failed.")
+            throw IllegalArgumentException("Root required on $deviceName. Deploying failed")
     }
 
     private fun String.replacePlaceholder(with: String? = null): String {
@@ -29,8 +30,12 @@ internal class Adb(
 
     internal fun deploy() {
         if (modeInstall) {
+            logger.info("Installing without mounting")
+
             PackageManager(device).install(file)
         } else {
+            logger.info("Installing by mounting")
+
             // push patched file
             device.copy(Constants.PATH_INIT_PUSH, file)
 
@@ -91,10 +96,10 @@ internal class Adb(
                 }
                 break
             } catch (e: Exception) {
-                throw RuntimeException("An error occurred while monitoring state of app", e)
+                throw RuntimeException("An error occurred while monitoring the state of app", e)
             }
         }
-        println("App closed, continuing.")
+        logger.info("Stopped logging because the app was closed")
         process.destroy()
         executor.shutdown()
     }

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

@@ -2,6 +2,7 @@ package app.revanced.utils.patcher
 
 import app.revanced.cli.command.MainCommand
 import app.revanced.cli.command.MainCommand.args
+import app.revanced.cli.command.MainCommand.logger
 import app.revanced.patcher.Patcher
 import app.revanced.patcher.data.base.Data
 import app.revanced.patcher.extensions.PatchExtensions.compatiblePackages
@@ -22,33 +23,40 @@ fun Patcher.addPatchesFiltered(
             val compatiblePackages = patch.compatiblePackages
             val patchName = patch.patchName
 
-            val prefix = "[skipped] $patchName"
+            val prefix = "Skipping $patchName"
 
             val args = MainCommand.args.pArgs!!
 
             if (excludePatches && args.excludedPatches.contains(patchName)) {
-                println("$prefix: Explicitly excluded.")
+                logger.info("$prefix: Explicitly excluded")
                 return@patch
             } else if (!patch.include) {
-                println("$prefix: Implicitly excluded.")
+                logger.info("$prefix: Explicitly excluded")
                 return@patch
             }
 
-            if (compatiblePackages == null) println("$prefix: Missing compatibility annotation. Continuing.")
+            if (compatiblePackages == null) logger.warn("$prefix: Missing compatibility annotation. Continuing.")
             else {
                 if (!compatiblePackages.any { it.name == packageName }) {
-                    println("$prefix: Incompatible package.")
+                    logger.warn("$prefix: Incompatible with $packageName. This patch is only compatible with ${
+                        compatiblePackages.joinToString(
+                            ", "
+                        ) { it.name }
+                    }")
                     return@patch
                 }
 
                 if (!(args.experimental || compatiblePackages.any { it.versions.isEmpty() || it.versions.any { version -> version == packageVersion } })) {
-                    println("$prefix: The package version is $packageVersion and is incompatible.")
+                    val compatibleWith = compatiblePackages.map { _package ->
+                        "${_package.name}: ${_package.versions.joinToString(", ")}"
+                    }.joinToString(";")
+                    logger.warn("$prefix: Incompatible with version $packageVersion. This patch is only compatible with version $compatibleWith")
                     return@patch
                 }
             }
 
+            logger.trace("Adding $patchName")
             includedPatches.add(patch)
-            println("[added] $patchName")
         }
         this.addPatches(includedPatches)
     }
@@ -57,14 +65,16 @@ fun Patcher.addPatchesFiltered(
 fun Patcher.applyPatchesVerbose() {
     this.applyPatches().forEach { (patch, result) ->
         if (result.isSuccess) {
-            println("[success] $patch")
+            logger.info("$patch succeeded")
             return@forEach
         }
-        println("[error] $patch:")
+        logger.error("$patch failed:")
         result.exceptionOrNull()!!.printStackTrace()
     }
 }
 
 fun Patcher.mergeFiles() {
-    this.addFiles(args.pArgs!!.mergeFiles)
+    this.addFiles(args.pArgs!!.mergeFiles) { file ->
+        logger.info("Merging $file")
+    }
 }

src/main/kotlin/app/revanced/utils/signature/Signature.kt

@@ -1,7 +1,6 @@
 package app.revanced.utils.signature
 
 import app.revanced.patcher.Patcher
-import org.jf.dexlib2.iface.Method
 
 object Signature {
 
@@ -49,7 +48,7 @@ object Signature {
          */
     }
 
-    private fun Method.toStr(): String {
-        return "${this.name}(${this.parameterTypes.joinToString("")})${this.returnType}"
-    }
+    //private fun Method.toStr(): String {
+    //    return "${this.name}(${this.parameterTypes.joinToString("")})${this.returnType}"
+    //}
 }

src/main/kotlin/app/revanced/utils/signing/Signer.kt

@@ -1,5 +1,7 @@
 package app.revanced.utils.signing
 
+import app.revanced.cli.command.MainCommand.logger
+import app.revanced.cli.signing.SigningOptions
 import com.android.apksig.ApkSigner
 import org.bouncycastle.asn1.x500.X500Name
 import org.bouncycastle.asn1.x509.SubjectPublicKeyInfo
@@ -17,9 +19,9 @@ import java.security.cert.X509Certificate
 import java.util.*
 
 internal class Signer(
-    private val cn: String, password: String
+    private val signingOptions: SigningOptions
 ) {
-    private val passwordCharArray = password.toCharArray()
+    private val passwordCharArray = signingOptions.password.toCharArray()
     private fun newKeystore(out: File) {
         val (publicKey, privateKey) = createKey()
         val privateKS = KeyStore.getInstance("BKS", "BC")
@@ -34,7 +36,7 @@ internal class Signer(
         val pair = gen.generateKeyPair()
         var serialNumber: BigInteger
         do serialNumber = BigInteger.valueOf(SecureRandom().nextLong()) while (serialNumber < BigInteger.ZERO)
-        val x500Name = X500Name("CN=$cn")
+        val x500Name = X500Name("CN=${signingOptions.cn}")
         val builder = X509v3CertificateBuilder(
             x500Name,
             serialNumber,
@@ -48,30 +50,30 @@ internal class Signer(
         return JcaX509CertificateConverter().getCertificate(builder.build(signer)) to pair.private
     }
 
-    fun signApk(input: File, output: File): File {
+    fun signApk(input: File, output: File) {
         Security.addProvider(BouncyCastleProvider())
 
         // TODO: keystore should be saved securely
-        val ks = File(input.parent, "${output.nameWithoutExtension}.keystore")
-        if (!ks.exists()) newKeystore(ks)
+        val ks = File(signingOptions.keyStoreFilePath)
+        if (!ks.exists()) newKeystore(ks) else {
+            logger.info("Found existing keystore: ${ks.nameWithoutExtension}")
+        }
 
         val keyStore = KeyStore.getInstance("BKS", "BC")
         FileInputStream(ks).use { fis -> keyStore.load(fis, null) }
         val alias = keyStore.aliases().nextElement()
 
         val config = ApkSigner.SignerConfig.Builder(
-            cn,
+            signingOptions.cn,
             keyStore.getKey(alias, passwordCharArray) as PrivateKey,
             listOf(keyStore.getCertificate(alias) as X509Certificate)
         ).build()
 
         val signer = ApkSigner.Builder(listOf(config))
-        signer.setCreatedBy(cn)
+        signer.setCreatedBy(signingOptions.cn)
         signer.setInputApk(input)
         signer.setOutputApk(output)
 
         signer.build().sign()
-
-        return ks
     }
 }