chore(release): 2.5.2 [skip ci]

## [2.5.2](https://github.com/revanced/revanced-cli/compare/v2.5.1...v2.5.2) (2022-07-10)

### Bug Fixes

* `defaultExclude` unused ([2015c2a](2015c2a1dc))

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,23 @@
+---
+name: Bug report
+about: Create a bug report on the CLI. Do not submit suggestions for patches here.
+title: 'problem: some problem'
+labels: bug
+
+---
+
+# 🐞 Issue
+
+<!-- Describe your issue in detail here -->
+
+# ⚙ Reproduce
+
+<!-- Include your environment and steps to reproduce the issue as detailed as possible -->
+
+# 🛠 Solution
+
+<!-- If applicable, add a possible solution -->
+
+# ⚠ Additional context
+
+<!-- Add any other context about the problem here -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest a change to the CLI. Do not submit suggestions for patches here.
+title: 'feat: some feature'
+labels: feature-request
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

CHANGELOG.md

@@ -1,3 +1,78 @@
+## [2.5.2](https://github.com/revanced/revanced-cli/compare/v2.5.1...v2.5.2) (2022-07-10)
+
+
+### Bug Fixes
+
+* `defaultExclude` unused ([2015c2a](https://github.com/revanced/revanced-cli/commit/2015c2a1dcc0290af237e2eb1ab4aaf5fc84d382))
+
+## [2.5.1](https://github.com/revanced/revanced-cli/compare/v2.5.0...v2.5.1) (2022-07-10)
+
+
+### Bug Fixes
+
+* Make clear what the --exclusive command actually does ([a26b0ea](https://github.com/revanced/revanced-cli/commit/a26b0ea64dcd0757b5b49c09137959751874d955))
+
+# [2.5.0](https://github.com/revanced/revanced-cli/compare/v2.4.0...v2.5.0) (2022-07-10)
+
+
+### Bug Fixes
+
+* null exception when resource patching is disabled ([#85](https://github.com/revanced/revanced-cli/issues/85)) ([125fa06](https://github.com/revanced/revanced-cli/commit/125fa06ca6bac66f790e4aba66887464189b3a63))
+* remove `excludePatches` check ([eb83cab](https://github.com/revanced/revanced-cli/commit/eb83cabfff6fbc28dd892f15b8e28278e284caa9))
+
+
+### Features
+
+* `--exclusive` switch ([#78](https://github.com/revanced/revanced-cli/issues/78)) ([8e91c12](https://github.com/revanced/revanced-cli/commit/8e91c12c5e3864c369005ef9fe7d9db668e86701))
+* `--uninstall` switch ([#84](https://github.com/revanced/revanced-cli/issues/84)) ([131100e](https://github.com/revanced/revanced-cli/commit/131100ef0043924a9c11eb9886b4f6b0373690d9))
+
+# [2.4.0](https://github.com/revanced/revanced-cli/compare/v2.3.3...v2.4.0) (2022-07-10)
+
+
+### Bug Fixes
+
+* wrong label in additional items [skip ci] ([cd3ded1](https://github.com/revanced/revanced-cli/commit/cd3ded1fbdb0c8eb7485912d5cbd6a2dd7455658))
+
+
+### Features
+
+* better output for excluded patches ([#77](https://github.com/revanced/revanced-cli/issues/77)) ([ac7c7a9](https://github.com/revanced/revanced-cli/commit/ac7c7a9a1a5c08322e3b206780d4f31104d8b570))
+* issue templates [skip ci] ([bac8c67](https://github.com/revanced/revanced-cli/commit/bac8c67d6f7bc10a38bb98a2f6e3f5cf6fa2e3e1))
+
+## [2.3.3](https://github.com/revanced/revanced-cli/compare/v2.3.2...v2.3.3) (2022-07-09)
+
+## [2.3.2](https://github.com/revanced/revanced-cli/compare/v2.3.1...v2.3.2) (2022-07-05)
+
+
+### Bug Fixes
+
+* fix noSuchMethodError ([00fec25](https://github.com/revanced/revanced-cli/commit/00fec2508a3421b7b5a246254e0cb08850eab6ea))
+
+## [2.3.1](https://github.com/revanced/revanced-cli/compare/v2.3.0...v2.3.1) (2022-07-04)
+
+# [2.3.0](https://github.com/revanced/revanced-cli/compare/v2.2.0...v2.3.0) (2022-07-03)
+
+
+### Features
+
+* separate logger to stdout & stderr ([#63](https://github.com/revanced/revanced-cli/issues/63)) ([0ddc2b5](https://github.com/revanced/revanced-cli/commit/0ddc2b54b739dae3e8ccc983bab73fc84e72be0a))
+
+# [2.2.0](https://github.com/revanced/revanced-cli/compare/v2.1.0...v2.2.0) (2022-07-03)
+
+
+### Features
+
+* separate options for `--list` ([#60](https://github.com/revanced/revanced-cli/issues/60)) ([52b3161](https://github.com/revanced/revanced-cli/commit/52b316150de397ebdee979caf51d4cb20961cf70))
+
+# [2.1.0](https://github.com/revanced/revanced-cli/compare/v2.0.5...v2.1.0) (2022-07-03)
+
+
+### Features
+
+* `--include` option ([#76](https://github.com/revanced/revanced-cli/issues/76)) ([57a1e7c](https://github.com/revanced/revanced-cli/commit/57a1e7c27fb0c4292e08332b88ccd57d69fa02c6))
+
+## [2.0.5](https://github.com/revanced/revanced-cli/compare/v2.0.4...v2.0.5) (2022-06-29)
+
 ## [2.0.4](https://github.com/revanced/revanced-cli/compare/v2.0.3...v2.0.4) (2022-06-28)
 
 ## [2.0.3](https://github.com/revanced/revanced-cli/compare/v2.0.2...v2.0.3) (2022-06-27)

build.gradle.kts

@@ -26,7 +26,7 @@ dependencies {
     implementation(kotlin("stdlib"))
     implementation(kotlin("reflect"))
 
-    implementation("app.revanced:revanced-patcher:2.1.0")
+    implementation("app.revanced:revanced-patcher:2.4.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 = 2.0.4
+version = 2.5.2

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

@@ -6,6 +6,7 @@ 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.compatiblePackages
 import app.revanced.patcher.extensions.PatchExtensions.description
 import app.revanced.patcher.extensions.PatchExtensions.patchName
 import app.revanced.patcher.util.patch.implementation.JarPatchBundle
@@ -32,6 +33,20 @@ internal object MainCommand : Runnable {
     lateinit var args: Args
 
     class Args {
+        @Option(names = ["-a", "--apk"], description = ["Input file to be patched"], required = true)
+        lateinit var inputFile: File
+
+        @Option(names = ["--uninstall"], description = ["Uninstall the mount variant"])
+        var uninstall: Boolean = false
+
+        @Option(names = ["-d", "--deploy-on"], description = ["If specified, deploy to adb device with given name"])
+        var deploy: String? = null
+
+        @ArgGroup(exclusive = false)
+        var sArgs: StartPatcherArgs? = null
+    }
+
+    class StartPatcherArgs {
         @Option(names = ["-b", "--bundles"], description = ["One or more bundles of patches"], required = true)
         var patchBundles = arrayOf<String>()
 
@@ -45,18 +60,30 @@ internal object MainCommand : Runnable {
     class ListingArgs {
         @Option(names = ["-l", "--list"], description = ["List patches only"], required = true)
         var listOnly: Boolean = false
+
+        @Option(names = ["--with-versions"], description = ["List patches with compatible versions"])
+        var withVersions: Boolean = false
+
+        @Option(names = ["--with-packages"], description = ["List patches with compatible packages"])
+        var withPackages: Boolean = false
+
+        @Option(names = ["--with-descriptions"], description = ["List patches with their descriptions"])
+        var withDescriptions: Boolean = true
     }
 
     class PatchingArgs {
-        @Option(names = ["-a", "--apk"], description = ["Input file to be patched"], required = true)
-        lateinit var inputFile: File
-
         @Option(names = ["-o", "--out"], description = ["Output file path"], required = true)
         lateinit var outputPath: String
 
         @Option(names = ["-e", "--exclude"], description = ["Explicitly exclude patches"])
         var excludedPatches = arrayOf<String>()
 
+        @Option(names = ["--exclusive"], description = ["Only installs the patches you include, not including any patch by default"])
+        var defaultExclude = false
+
+        @Option(names = ["-i", "--include"], description = ["Include patches"])
+        var includedPatches = arrayOf<String>()
+
         @Option(names = ["-r", "--resource-patcher"], description = ["Disable patching resources"])
         var disableResourcePatching: Boolean = false
 
@@ -78,9 +105,6 @@ internal object MainCommand : Runnable {
         @Option(names = ["-p", "--password"], description = ["Overwrite the default password for the signed file"])
         var password = "ReVanced"
 
-        @Option(names = ["-d", "--deploy-on"], description = ["If specified, deploy to adb device with given name"])
-        var deploy: String? = null
-
         @Option(names = ["-t", "--temp-dir"], description = ["Temporal resource cache directory"])
         var cacheDirectory = "revanced-cache"
 
@@ -92,18 +116,37 @@ internal object MainCommand : Runnable {
     }
 
     override fun run() {
-        if (args.lArgs?.listOnly == true) {
-            for (patchBundlePath in args.patchBundles) for (patch in JarPatchBundle(patchBundlePath).loadPatches()) {
-                logger.info("${patch.patchName}: ${patch.description}")
-            }
+        if (args.sArgs?.lArgs?.listOnly == true) {
+            printListOfPatches()
             return
         }
 
-        val args = args.pArgs ?: return
+        if (args.uninstall) {
+            // temporarily get package name using Patcher method
+            // fix: abstract options in patcher
+            val patcher = app.revanced.patcher.Patcher(
+                PatcherOptions(
+                    args.inputFile,
+                    "uninstaller-cache",
+                    false
+                )
+            )
+            File("uninstaller-cache").deleteRecursively()
+
+            val adb: Adb? = args.deploy?.let {
+                Adb(File("placeholder_file"), patcher.data.packageMetadata.packageName, args.deploy!!, false)
+            }
+            adb?.uninstall()
+
+            return
+        }
+
+        val _args = args
+        val args = args.sArgs?.pArgs ?: return
 
         val patcher = app.revanced.patcher.Patcher(
             PatcherOptions(
-                args.inputFile,
+                _args.inputFile,
                 args.cacheDirectory,
                 !args.disableResourcePatching,
                 logger = PatcherLogger
@@ -112,10 +155,9 @@ internal object MainCommand : Runnable {
 
         val outputFile = File(args.outputPath)
 
-        val adb: Adb? = args.deploy?.let {
-            Adb(outputFile, patcher.data.packageMetadata.packageName, args.deploy!!, !args.mount)
+        val adb: Adb? = _args.deploy?.let {
+            Adb(outputFile, patcher.data.packageMetadata.packageName, _args.deploy!!, !args.mount)
         }
-
         val patchedFile = if (args.mount) outputFile
         else File(args.cacheDirectory).resolve("${outputFile.nameWithoutExtension}_raw.apk")
 
@@ -139,8 +181,39 @@ internal object MainCommand : Runnable {
 
         adb?.deploy()
 
-        if (args.clean && args.deploy != null) Files.delete(outputFile.toPath())
+        if (args.clean && _args.deploy != null) Files.delete(outputFile.toPath())
 
         logger.info("Finished")
     }
+
+    private fun printListOfPatches() {
+        for (patchBundlePath in args.sArgs?.patchBundles!!) for (patch in JarPatchBundle(patchBundlePath).loadPatches()) {
+            for (compatiblePackage in patch.compatiblePackages!!) {
+                val packageEntryStr = buildString {
+                    // Add package if flag is set
+                    if (args.sArgs?.lArgs?.withPackages == true) {
+                        val packageName = compatiblePackage.name.substringAfterLast(".").padStart(10)
+                        append(packageName)
+                        append("\t")
+                    }
+                    // Add patch name
+                    val patchName = patch.patchName.padStart(25)
+                    append(patchName)
+                    // Add description if flag is set.
+                    if (args.sArgs?.lArgs?.withDescriptions == true) {
+                        append("\t")
+                        append(patch.description)
+                    }
+                    // Add compatible versions, if flag is set
+                    if (args.sArgs?.lArgs?.withVersions == true) {
+                        val compatibleVersions = compatiblePackage.versions.joinToString(separator = ", ")
+                        append("\t")
+                        append(compatibleVersions)
+                    }
+
+                }
+                logger.info(packageEntryStr)
+            }
+        }
+    }
 }

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

@@ -3,18 +3,26 @@ package app.revanced.cli.logging.impl
 import app.revanced.cli.command.MainCommand
 import app.revanced.cli.logging.CliLogger
 import java.util.logging.Logger
+import java.util.logging.SimpleFormatter
+import java.util.logging.StreamHandler
 
 internal class DefaultCliLogger(
-    private val logger: Logger = Logger.getLogger(MainCommand::javaClass.name)
+    private val logger: Logger = Logger.getLogger(MainCommand::javaClass.name),
+    private val errorLogger: Logger = Logger.getLogger(MainCommand::javaClass.name + "Err")
 ) : CliLogger {
+
+    init {
+        logger.useParentHandlers = false
+        logger.addHandler(StreamHandler(System.out, SimpleFormatter()))
+    }
     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 error(msg: String) = errorLogger.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)
-}
+    override fun warn(msg: String) = errorLogger.warning(msg)
+}

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

@@ -11,18 +11,19 @@ import java.nio.file.Files
 
 internal object Patcher {
     internal fun start(patcher: app.revanced.patcher.Patcher, output: File) {
-        val args = args.pArgs!!
+        val inputFile = args.inputFile
+        val args = args.sArgs?.pArgs!!
 
         // merge files like necessary integrations
         patcher.mergeFiles()
         // add patches, but filter incompatible or excluded patches
-        patcher.addPatchesFiltered(excludePatches = args.excludedPatches.isNotEmpty())
+        patcher.addPatchesFiltered()
         // apply patches
         patcher.applyPatchesVerbose()
 
         // write output file
         if (output.exists()) Files.delete(output.toPath())
-        args.inputFile.copyTo(output)
+        inputFile.copyTo(output)
 
         val result = patcher.save()
         ZipFileSystemUtils(output).use { outputFileSystem ->
@@ -41,7 +42,7 @@ internal object Patcher {
                 }
             }
 
-            outputFileSystem.uncompress(*result.doNotCompress!!.toTypedArray())
+            result.doNotCompress?.let { outputFileSystem.uncompress(*it.toTypedArray()) }
         }
     }
 }

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

@@ -8,7 +8,7 @@ import java.io.File
 
 object Signing {
     fun start(inputFile: File, outputFile: File, signingOptions: SigningOptions) {
-        val cacheDirectory = File(args.pArgs!!.cacheDirectory)
+        val cacheDirectory = File(args.sArgs?.pArgs?.cacheDirectory)
         val alignedOutput = cacheDirectory.resolve("${outputFile.nameWithoutExtension}_aligned.apk")
         val signedOutput = cacheDirectory.resolve("${outputFile.nameWithoutExtension}_signed.apk")
 

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

@@ -21,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. Task failed")
     }
 
     private fun String.replacePlaceholder(with: String? = null): String {
@@ -39,7 +39,7 @@ internal class Adb(
             // push patched file
             device.copy(Constants.PATH_INIT_PUSH, file)
 
-            // create revanced path
+            // create revanced folder path
             device.run("${Constants.COMMAND_CREATE_DIR} ${Constants.PATH_REVANCED}")
 
             // prepare mounting the apk
@@ -53,16 +53,8 @@ internal class Adb(
             // install mount script
             device.run(Constants.COMMAND_INSTALL_MOUNT.replacePlaceholder())
 
-            // push umount script
-            device.createFile(
-                Constants.PATH_INIT_PUSH,
-                Constants.CONTENT_UMOUNT_SCRIPT.replacePlaceholder()
-            )
-            // install mount script
-            device.run(Constants.COMMAND_INSTALL_UMOUNT.replacePlaceholder())
-
             // unmount the apk for sanity
-            device.run(Constants.PATH_UMOUNT.replacePlaceholder())
+            device.run(Constants.COMMAND_UMOUNT.replacePlaceholder())
             // mount the apk
             device.run(Constants.PATH_MOUNT.replacePlaceholder())
 
@@ -74,6 +66,21 @@ internal class Adb(
         }
     }
 
+    internal fun uninstall() {
+        logger.info("Uninstalling by unmounting")
+
+        // unmount the apk
+        device.run(Constants.COMMAND_UMOUNT.replacePlaceholder())
+
+        // delete revanced app
+        device.run(Constants.COMMAND_DELETE.replacePlaceholder(Constants.PATH_REVANCED_APP).replacePlaceholder())
+
+        // delete mount script
+        device.run(Constants.COMMAND_DELETE.replacePlaceholder(Constants.PATH_MOUNT).replacePlaceholder())
+
+        logger.info("Finished uninstalling")
+    }
+
     private fun log() {
         val executor = Executors.newSingleThreadExecutor()
         val pipe = if (logging) {
@@ -103,4 +110,4 @@ internal class Adb(
         process.destroy()
         executor.shutdown()
     }
-}
+}

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

@@ -21,31 +21,25 @@ internal object Constants {
     internal const val PATH_REVANCED = "/data/adb/revanced/"
 
     // revanced apk path
-    private const val PATH_REVANCED_APP = "$PATH_REVANCED$PLACEHOLDER.apk"
+    internal const val PATH_REVANCED_APP = "$PATH_REVANCED$PLACEHOLDER.apk"
 
-    // (un)mount script paths
+    // delete command
+    internal const val COMMAND_DELETE = "rm -rf $PLACEHOLDER"
+
+    // mount script path
     internal const val PATH_MOUNT = "/data/adb/service.d/$NAME_MOUNT_SCRIPT"
-    internal const val PATH_UMOUNT = "/data/adb/post-fs-data.d/un$NAME_MOUNT_SCRIPT"
 
     // move to revanced apk path & set permissions
     internal const val COMMAND_PREPARE_MOUNT_APK =
         "base_path=\"$PATH_REVANCED_APP\" && mv $PATH_INIT_PUSH ${'$'}base_path && chmod 644 ${'$'}base_path && chown system:system ${'$'}base_path && chcon u:object_r:apk_data_file:s0  ${'$'}base_path"
 
+    // unmount command
+    internal const val COMMAND_UMOUNT =
+        "stock_path=${'$'}( pm path $PLACEHOLDER | grep base | sed 's/package://g' ) && umount -l ${'$'}stock_path"
+
     // install mount script & set permissions
     internal const val COMMAND_INSTALL_MOUNT = "mv $PATH_INIT_PUSH $PATH_MOUNT && $COMMAND_CHMOD_MOUNT $PATH_MOUNT"
 
-    // install umount script & set permissions
-    internal const val COMMAND_INSTALL_UMOUNT = "mv $PATH_INIT_PUSH $PATH_UMOUNT && $COMMAND_CHMOD_MOUNT $PATH_UMOUNT"
-
-    // unmount script
-    internal val CONTENT_UMOUNT_SCRIPT =
-        """
-            #!/system/bin/sh
-            
-            stock_path=${'$'}( pm path $PLACEHOLDER | grep base | sed 's/package://g' )
-            umount -l ${'$'}stock_path
-        """.trimIndent()
-
     // mount script
     internal val CONTENT_MOUNT_SCRIPT =
         """

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

@@ -11,13 +11,11 @@ import app.revanced.patcher.extensions.PatchExtensions.patchName
 import app.revanced.patcher.patch.Patch
 import app.revanced.patcher.util.patch.implementation.JarPatchBundle
 
-fun Patcher.addPatchesFiltered(
-    excludePatches: Boolean = false
-) {
+fun Patcher.addPatchesFiltered() {
     val packageName = this.data.packageMetadata.packageName
     val packageVersion = this.data.packageMetadata.packageVersion
 
-    args.patchBundles.forEach { bundle ->
+    args.sArgs?.patchBundles!!.forEach { bundle ->
         val includedPatches = mutableListOf<Class<out Patch<Data>>>()
         JarPatchBundle(bundle).loadPatches().forEach patch@{ patch ->
             val compatiblePackages = patch.compatiblePackages
@@ -25,13 +23,13 @@ fun Patcher.addPatchesFiltered(
 
             val prefix = "Skipping $patchName"
 
-            val args = MainCommand.args.pArgs!!
+            val args = MainCommand.args.sArgs?.pArgs!!
 
-            if (excludePatches && args.excludedPatches.contains(patchName)) {
-                logger.info("$prefix: Explicitly excluded")
+            if (args.excludedPatches.contains(patchName)) {
+                logger.info("$prefix: Explicitely excluded")
                 return@patch
-            } else if (!patch.include) {
-                logger.info("$prefix: Explicitly excluded")
+            } else if ((!patch.include || args.defaultExclude) && !args.includedPatches.contains(patchName)) {
+                logger.info("$prefix: Not explicitly included")
                 return@patch
             }
 
@@ -74,7 +72,7 @@ fun Patcher.applyPatchesVerbose() {
 }
 
 fun Patcher.mergeFiles() {
-    this.addFiles(args.pArgs!!.mergeFiles) { file ->
+    this.addFiles(args.sArgs?.pArgs!!.mergeFiles) { file ->
         logger.info("Merging $file")
     }
-}
+}