chore(release): 1.6.3 [skip ci]

## [1.6.3](https://github.com/revanced/revanced-cli/compare/v1.6.2...v1.6.3) (2022-06-21)

### Bug Fixes

* update patcher version ([80c11fe](80c11fef73))

.github/workflows/release.yml

@@ -28,12 +28,10 @@ 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 }}
-        run: ./gradlew build
+        run: ./gradlew build clean
       - name: Setup semantic-release
         run: npm install -g semantic-release @semantic-release/git @semantic-release/changelog gradle-semantic-release-plugin -D
       - name: Release

.releaserc

@@ -10,6 +10,7 @@
     "@semantic-release/commit-analyzer",
     "@semantic-release/release-notes-generator",
     "@semantic-release/changelog",
+    "gradle-semantic-release-plugin",
     [
       "@semantic-release/git",
       {

CHANGELOG.md

@@ -1,3 +1,83 @@
+## [1.6.3](https://github.com/revanced/revanced-cli/compare/v1.6.2...v1.6.3) (2022-06-21)
+
+
+### Bug Fixes
+
+* update patcher version ([80c11fe](https://github.com/revanced/revanced-cli/commit/80c11fef734bdba9026e91f95ee0a4a522cbefab))
+
+## [1.6.2](https://github.com/revanced/revanced-cli/compare/v1.6.1...v1.6.2) (2022-06-21)
+
+
+### Bug Fixes
+
+* CLI not working ([29105ba](https://github.com/revanced/revanced-cli/commit/29105bab3dabd9d16af6b511caef9727f98afd1a))
+* improper use of mount variable ([31853fe](https://github.com/revanced/revanced-cli/commit/31853fe5393af04805857b78a54434e1c51e4c8e))
+
+## [1.6.1](https://github.com/revanced/revanced-cli/compare/v1.6.0...v1.6.1) (2022-06-21)
+
+
+### Bug Fixes
+
+* remove `-e` from `experimental` option ([3829136](https://github.com/revanced/revanced-cli/commit/3829136c49ddce1dc6b01eda04ce013540b213c2))
+
+# [1.6.0](https://github.com/revanced/revanced-cli/compare/v1.5.1...v1.6.0) (2022-06-21)
+
+
+### Features
+
+* rename `debugging` option to `experimental` ([98bd6f3](https://github.com/revanced/revanced-cli/commit/98bd6f3f4b3eb34c445cbd5e3a3196f399f8bb3b))
+* use `install` mode by default ([1a3db77](https://github.com/revanced/revanced-cli/commit/1a3db77c21b5795220fbac1ec36827fc521fface))
+
+## [1.5.1](https://github.com/revanced/revanced-cli/compare/v1.5.0...v1.5.1) (2022-06-21)
+
+
+### Bug Fixes
+
+* update patcher version ([09b9027](https://github.com/revanced/revanced-cli/commit/09b9027e5e28f0483e74b711cf65a7876267a339)), closes [#45](https://github.com/revanced/revanced-cli/issues/45)
+
+# [1.5.0](https://github.com/revanced/revanced-cli/compare/v1.4.5...v1.5.0) (2022-06-20)
+
+
+### Features
+
+* allow listing patches without other parameters ([#42](https://github.com/revanced/revanced-cli/issues/42)) ([b977d70](https://github.com/revanced/revanced-cli/commit/b977d7039f877be242823a4eef0fb8df6550dd05))
+
+## [1.4.5](https://github.com/revanced/revanced-cli/compare/v1.4.4...v1.4.5) (2022-06-20)
+
+
+### Bug Fixes
+
+* update patcher version (fix apktool) ([496f821](https://github.com/revanced/revanced-cli/commit/496f82121879443609667a792cc1e16441ef5c2f))
+
+## [1.4.4](https://github.com/revanced/revanced-cli/compare/v1.4.3...v1.4.4) (2022-06-18)
+
+
+### Bug Fixes
+
+* add execute permission to `./gradlew` file ([#36](https://github.com/revanced/revanced-cli/issues/36)) ([072d9e1](https://github.com/revanced/revanced-cli/commit/072d9e15d7e44b1080923f3afeb194eeb4fe4682))
+
+## [1.4.3](https://github.com/revanced/revanced-cli/compare/v1.4.2...v1.4.3) (2022-06-18)
+
+
+### Bug Fixes
+
+* update patcher to 1.2.5 ([055c282](https://github.com/revanced/revanced-cli/commit/055c282dd3d147e3600bdfdf4fd6b4bd72cbf379))
+
+## [1.4.2](https://github.com/revanced/revanced-cli/compare/v1.4.1...v1.4.2) (2022-06-16)
+
+
+### Bug Fixes
+
+* dummy publish task (1/2) [skip ci] ([afff4c8](https://github.com/revanced/revanced-cli/commit/afff4c8418bd33959440a3ac9e6c46816b3153ad))
+* releases (2/2) ([227d8d9](https://github.com/revanced/revanced-cli/commit/227d8d94c89ec24051bd5bc20808049164d92492))
+
+## [1.4.1](https://github.com/revanced/revanced-cli/compare/v1.4.0...v1.4.1) (2022-06-14)
+
+
+### Bug Fixes
+
+* move the keystore to the output directory ([6ceb449](https://github.com/revanced/revanced-cli/commit/6ceb449cf8539a92d89eeba8136fdc686319e2ef))
+
 # [1.4.0](https://github.com/revanced/revanced-cli/compare/v1.3.3...v1.4.0) (2022-06-14)
 
 

build.gradle.kts

@@ -31,7 +31,8 @@ repositories {
 dependencies {
     implementation(kotlin("stdlib"))
     implementation(kotlin("reflect"))
-    implementation("app.revanced:revanced-patcher:1.1.0")
+
+    implementation("app.revanced:revanced-patcher:1.3.4")
     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
@@ -49,4 +50,12 @@ tasks {
             attributes("Implementation-Version" to project.version)
         }
     }
+    // Dummy task to fix the Gradle semantic-release plugin.
+    // Remove this if you forked it to support building only.
+    // Tracking issue: https://github.com/KengoTODA/gradle-semantic-release-plugin/issues/435
+    register<DefaultTask>("publish") {
+        group = "publish"
+        description = "Dummy task"
+        dependsOn(build)
+    }
 }

gradle.properties

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

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

@@ -6,102 +6,123 @@ import app.revanced.patcher.PatcherOptions
 import app.revanced.patcher.extensions.PatchExtensions.patchName
 import app.revanced.patcher.util.patch.implementation.JarPatchBundle
 import app.revanced.utils.adb.Adb
-import picocli.CommandLine.Command
+import picocli.CommandLine.*
-import picocli.CommandLine.Option
 import java.io.File
 import java.nio.file.Files
 
 @Command(
-    name = "ReVanced-CLI", version = ["1.0.0"], mixinStandardHelpOptions = true,
+    name = "ReVanced-CLI",
+    version = ["1.0.0"],
+    mixinStandardHelpOptions = true
 )
 internal object MainCommand : Runnable {
-    @Option(names = ["-a", "--apk"], description = ["Input file to be patched"], required = true)
+    @ArgGroup(exclusive = false, multiplicity = "1")
-    lateinit var inputFile: File
+    lateinit var args: Args
 
-    @Option(names = ["-o", "--out"], description = ["Output file path"], required = true)
+    class Args {
-    lateinit var outputPath: String
+        @Option(names = ["-b", "--bundles"], description = ["One or more bundles of patches"], required = true)
+        var patchBundles = arrayOf<String>()
 
-    @Option(
+        @ArgGroup(exclusive = false)
-        names = ["-i", "--include"],
+        var lArgs: ListingArgs? = null
-        description = ["Which patches to include. If none is specified, all compatible default patches will be included"]
-    )
-    var includedPatches = arrayOf<String>()
 
-    @Option(names = ["-r", "--resource-patcher"], description = ["Disable patching resources"])
+        @ArgGroup(exclusive = false)
-    var disableResourcePatching: Boolean = false
+        var pArgs: PatchingArgs? = null
+    }
 
-    @Option(names = ["--debugging"], description = ["Disable patch version compatibility"])
+    class ListingArgs {
-    var debugging: Boolean = false
+        @Option(names = ["-l", "--list"], description = ["List patches only"], required = true)
+        var listOnly: Boolean = false
+    }
 
-    @Option(names = ["-m", "--merge"], description = ["One or more dex file containers to merge"])
+    class PatchingArgs {
-    var mergeFiles = listOf<File>()
+        @Option(names = ["-a", "--apk"], description = ["Input file to be patched"], required = true)
+        lateinit var inputFile: File
 
-    @Option(names = ["-b", "--bundles"], description = ["One or more bundles of patches"])
+        @Option(names = ["-o", "--out"], description = ["Output file path"], required = true)
-    var patchBundles = arrayOf<String>()
+        lateinit var outputPath: String
 
-    @Option(names = ["-l", "--list"], description = ["List patches only"])
+        @Option(names = ["-e", "--exclude"], description = ["Explicitly exclude patches"])
-    var listOnly: Boolean = false
+        var excludedPatches = arrayOf<String>()
 
-    @Option(names = ["--install"], description = ["If specified, instead of mounting, install"])
+        @Option(names = ["-r", "--resource-patcher"], description = ["Disable patching resources"])
-    var install: Boolean = false
+        var disableResourcePatching: Boolean = false
 
-    @Option(names = ["--cn"], description = ["Overwrite the default CN for the signed file"])
+        @Option(names = ["--experimental"], description = ["Disable patch version compatibility patch"])
-    var cn = "ReVanced"
+        var experimental: Boolean = false
 
-    @Option(names = ["-p", "--password"], description = ["Overwrite the default password for the signed file"])
+        @Option(names = ["-m", "--merge"], description = ["One or more dex file containers to merge"])
-    var password = "ReVanced"
+        var mergeFiles = listOf<File>()
 
-    @Option(names = ["-d", "--deploy-on"], description = ["If specified, deploy to adb device with given name"])
+        @Option(names = ["--mount"], description = ["If specified, instead of installing, mount"])
-    var deploy: String? = null
+        var mount: Boolean = false
 
-    @Option(names = ["-t", "--temp-dir"], description = ["Temporal resource cache directory"])
+        @Option(names = ["--cn"], description = ["Overwrite the default CN for the signed file"])
-    var cacheDirectory = "revanced-cache"
+        var cn = "ReVanced"
 
-    @Option(
+        @Option(names = ["-p", "--password"], description = ["Overwrite the default password for the signed file"])
-        names = ["-c", "--clean"],
+        var password = "ReVanced"
-        description = ["Clean the temporal resource cache directory. This will be done anyways when running the patcher"]
+
-    )
+        @Option(names = ["-d", "--deploy-on"], description = ["If specified, deploy to adb device with given name"])
-    var clean: Boolean = false
+        var deploy: String? = null
+
+        @Option(names = ["-t", "--temp-dir"], description = ["Temporal resource cache directory"])
+        var cacheDirectory = "revanced-cache"
+
+        @Option(
+            names = ["-c", "--clean"],
+            description = ["Clean the temporal resource cache directory. This will be done anyways when running the patcher"]
+        )
+        var clean: Boolean = false
+    }
 
     override fun run() {
-        if (listOnly) {
+        if (args.lArgs?.listOnly == true) {
-            for (patchBundlePath in patchBundles) for (patch in JarPatchBundle(patchBundlePath).loadPatches()) {
+            for (patchBundlePath in args.patchBundles) for (patch in JarPatchBundle(patchBundlePath).loadPatches()) {
                 println("[available] ${patch.patchName}")
             }
             return
         }
 
-        val patcher = app.revanced.patcher.Patcher(PatcherOptions(inputFile, cacheDirectory, !disableResourcePatching))
+        val args = args.pArgs ?: return
 
-        val outputFile = File(outputPath)
+        val patcher = app.revanced.patcher.Patcher(
+            PatcherOptions(
+                args.inputFile, args.cacheDirectory, !args.disableResourcePatching
+            )
+        )
 
-        val adb: Adb? = deploy?.let {
+        val outputFile = File(args.outputPath)
-            Adb(outputFile, patcher.data.packageMetadata.packageName, deploy!!, install)
+
+        val adb: Adb? = args.deploy?.let {
+            Adb(outputFile, patcher.data.packageMetadata.packageName, args.deploy!!, !args.mount)
         }
 
-        val patchedFile = if (install) File(cacheDirectory).resolve("${outputFile.nameWithoutExtension}_raw.apk") else outputFile
+        val patchedFile = if (args.mount) {
+            File(args.cacheDirectory).resolve("${outputFile.nameWithoutExtension}_raw.apk")
+        } else outputFile
 
         Patcher.start(patcher, patchedFile)
 
         println("[aligning & signing]")
 
-        if (install) {
+        if (!args.mount) {
             Signing.start(
                 patchedFile,
                 outputFile,
-                cn,
+                args.cn,
-                password,
+                args.password,
             )
         }
 
-        if (clean) File(cacheDirectory).deleteRecursively()
+        if (args.clean) File(args.cacheDirectory).deleteRecursively()
 
         adb?.let {
             println("[deploying]")
             it.deploy()
         }
 
-        if (clean && deploy != null) Files.delete(outputFile.toPath())
+        if (args.clean && args.deploy != null) Files.delete(outputFile.toPath())
 
         println("[done]")
     }

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

@@ -1,9 +1,6 @@
 package app.revanced.cli.patcher
 
-import app.revanced.cli.command.MainCommand.cacheDirectory
+import app.revanced.cli.command.MainCommand.args
-import app.revanced.cli.command.MainCommand.disableResourcePatching
-import app.revanced.cli.command.MainCommand
-import app.revanced.cli.command.MainCommand.includedPatches
 import app.revanced.utils.filesystem.ZipFileSystemUtils
 import app.revanced.utils.patcher.addPatchesFiltered
 import app.revanced.utils.patcher.applyPatchesVerbose
@@ -13,27 +10,33 @@ import java.nio.file.Files
 
 internal object Patcher {
     internal fun start(patcher: app.revanced.patcher.Patcher, output: File) {
+        val args = args.pArgs!!
+
         // merge files like necessary integrations
         patcher.mergeFiles()
         // add patches, but filter incompatible or excluded patches
-        patcher.addPatchesFiltered(includeFilter = includedPatches.isNotEmpty())
+        patcher.addPatchesFiltered(excludePatches = args.excludedPatches.isNotEmpty())
         // apply patches
         patcher.applyPatchesVerbose()
 
         // write output file
         if (output.exists()) Files.delete(output.toPath())
-        MainCommand.inputFile.copyTo(output)
+        args.inputFile.copyTo(output)
 
-        ZipFileSystemUtils(output).use { fileSystem ->
+        val result = patcher.save()
+        val inputFile = if (!args.disableResourcePatching && result.resourceFile != null) {
+            result.resourceFile
+        } else null
+        ZipFileSystemUtils(inputFile, output).use { fileSystem ->
             // replace all dex files
-            val result = patcher.save()
             result.dexFiles.forEach {
                 fileSystem.write(it.name, it.memoryDataStore.data)
             }
 
-            // write resources
+            // inputFile being null implies resource patching being disabled
-            if (!disableResourcePatching) {
+            if (inputFile != null) {
-                fileSystem.writePathRecursively(File(cacheDirectory).resolve("build").toPath())
+                // write resources
+                fileSystem.writeInput()
                 fileSystem.uncompress(*result.doNotCompress!!.toTypedArray())
             }
         }

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

@@ -1,13 +1,13 @@
 package app.revanced.cli.signing
 
-import app.revanced.cli.command.MainCommand.cacheDirectory
+import app.revanced.cli.command.MainCommand.args
 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) {
-        val cacheDirectory = File(cacheDirectory)
+        val cacheDirectory = File(args.pArgs!!.cacheDirectory)
         val alignedOutput = cacheDirectory.resolve("${outputFile.nameWithoutExtension}_aligned.apk")
         val signedOutput = cacheDirectory.resolve("${outputFile.nameWithoutExtension}_signed.apk")
 
@@ -16,9 +16,10 @@ object Signing {
         // sign the alignedOutput and write to signedOutput
         // the reason is, in case the signer fails
         // it does not damage the output file
-        Signer(cn, password).signApk(alignedOutput, signedOutput)
+        val keyStore = Signer(cn, password).signApk(alignedOutput, signedOutput)
 
-        // afterwards copy over the file to the output
+        // afterwards copy over the file and the keystore to the output
         signedOutput.copyTo(outputFile, true)
+        keyStore.copyTo(outputFile.resolveSibling(keyStore.name), true)
     }
 }

src/main/kotlin/app/revanced/utils/filesystem/ZipFileSystemUtils.kt

@@ -7,12 +7,17 @@ import java.nio.file.Files
 import java.nio.file.Path
 import java.util.zip.ZipEntry
 
-internal class ZipFileSystemUtils(
+internal class ZipFileSystemUtils(input: File?, output: File) : Closeable {
-    file: File
+    private val inFileSystem = if (input != null) {
-) : Closeable {
+        FileSystems.newFileSystem(input.toPath())
-    private var zipFileSystem = FileSystems.newFileSystem(file.toPath(), mapOf("noCompression" to true))
+    } else null
+    private val outFileSystem = FileSystems.newFileSystem(output.toPath(), mapOf("noCompression" to true))
 
     private fun Path.deleteRecursively() {
+        if (!Files.exists(this)) {
+            throw IllegalStateException("File exists in input but not in output, cannot delete")
+        }
+
         if (Files.isDirectory(this)) {
             Files.list(this).forEach { path ->
                 path.deleteRecursively()
@@ -22,19 +27,25 @@ internal class ZipFileSystemUtils(
         Files.delete(this)
     }
 
-    internal fun writePathRecursively(path: Path) {
+    internal fun writeInput() {
-        Files.list(path).let { fileStream ->
+        if (inFileSystem == null) {
+            throw IllegalArgumentException("Input file not set")
+        }
+        val root = inFileSystem.getPath(inFileSystem.separator)
+
+        Files.list(root).close()
+
+        Files.list(root).also { fileStream ->
             fileStream.forEach { filePath ->
-                val fileSystemPath = filePath.getRelativePath(path)
+                val fileSystemPath = filePath.getRelativePath(root)
                 fileSystemPath.deleteRecursively()
             }
-
-            fileStream
         }.close()
 
-        Files.walk(path).let { fileStream ->
+        Files.walk(root).also { fileStream ->
+            // don't include build directory by skipping the root node.
             fileStream.skip(1).forEach { filePath ->
-                val relativePath = filePath.getRelativePath(path)
+                val relativePath = filePath.getRelativePath(root)
 
                 if (Files.isDirectory(filePath)) {
                     Files.createDirectory(relativePath)
@@ -43,17 +54,18 @@ internal class ZipFileSystemUtils(
 
                 Files.copy(filePath, relativePath)
             }
-
-            fileStream
         }.close()
     }
 
-    internal fun write(path: String, content: ByteArray) = Files.write(zipFileSystem.getPath(path), content)
+    internal fun write(path: String, content: ByteArray) = Files.write(outFileSystem.getPath(path), content)
 
-    private fun Path.getRelativePath(path: Path): Path = zipFileSystem.getPath(path.relativize(this).toString())
+    private fun Path.getRelativePath(path: Path): Path = outFileSystem.getPath(path.relativize(this).toString())
 
     internal fun uncompress(vararg paths: String) =
-        paths.forEach { Files.setAttribute(zipFileSystem.getPath(it), "zip:method", ZipEntry.STORED) }
+        paths.forEach { Files.setAttribute(outFileSystem.getPath(it), "zip:method", ZipEntry.STORED) }
 
-    override fun close() = zipFileSystem.close()
+    override fun close() {
+        inFileSystem?.close()
+        outFileSystem.close()
+    }
 }

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

@@ -1,8 +1,7 @@
 package app.revanced.utils.patcher
 
 import app.revanced.cli.command.MainCommand
-import app.revanced.cli.command.MainCommand.debugging
+import app.revanced.cli.command.MainCommand.args
-import app.revanced.cli.command.MainCommand.patchBundles
 import app.revanced.patcher.Patcher
 import app.revanced.patcher.data.base.Data
 import app.revanced.patcher.extensions.PatchExtensions.compatiblePackages
@@ -12,12 +11,12 @@ import app.revanced.patcher.patch.base.Patch
 import app.revanced.patcher.util.patch.implementation.JarPatchBundle
 
 fun Patcher.addPatchesFiltered(
-    includeFilter: Boolean = false
+    excludePatches: Boolean = false
 ) {
     val packageName = this.data.packageMetadata.packageName
     val packageVersion = this.data.packageMetadata.packageVersion
 
-    patchBundles.forEach { bundle ->
+    args.patchBundles.forEach { bundle ->
         val includedPatches = mutableListOf<Class<out Patch<Data>>>()
         JarPatchBundle(bundle).loadPatches().forEach patch@{ patch ->
             val compatiblePackages = patch.compatiblePackages
@@ -25,11 +24,11 @@ fun Patcher.addPatchesFiltered(
 
             val prefix = "[skipped] $patchName"
 
-            if (includeFilter) {
+            val args = MainCommand.args.pArgs!!
-                if (!MainCommand.includedPatches.contains(patchName)) {
+
-                    println("$prefix: Explicitly excluded.")
+            if (excludePatches && args.excludedPatches.contains(patchName)) {
-                    return@patch
+                println("$prefix: Explicitly excluded.")
-                }
+                return@patch
             } else if (!patch.include) {
                 println("$prefix: Implicitly excluded.")
                 return@patch
@@ -42,7 +41,7 @@ fun Patcher.addPatchesFiltered(
                     return@patch
                 }
 
-                if (!(debugging || compatiblePackages.any { it.versions.isEmpty() || it.versions.any { version -> version == packageVersion }})) {
+                if (!(args.experimental || compatiblePackages.any { it.versions.isEmpty() || it.versions.any { version -> version == packageVersion } })) {
                     println("$prefix: The package version is $packageVersion and is incompatible.")
                     return@patch
                 }
@@ -67,5 +66,5 @@ fun Patcher.applyPatchesVerbose() {
 }
 
 fun Patcher.mergeFiles() {
-    this.addFiles(MainCommand.mergeFiles)
+    this.addFiles(args.pArgs!!.mergeFiles)
-}
+}

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

@@ -48,10 +48,11 @@ internal class Signer(
         return JcaX509CertificateConverter().getCertificate(builder.build(signer)) to pair.private
     }
 
-    fun signApk(input: File, output: File) {
+    fun signApk(input: File, output: File): File {
         Security.addProvider(BouncyCastleProvider())
 
-        val ks = File(input.parent, "revanced-cli.keystore")
+        // TODO: keystore should be saved securely
+        val ks = File(input.parent, "${output.nameWithoutExtension}.keystore")
         if (!ks.exists()) newKeystore(ks)
 
         val keyStore = KeyStore.getInstance("BKS", "BC")
@@ -70,5 +71,7 @@ internal class Signer(
         signer.setOutputApk(output)
 
         signer.build().sign()
+
+        return ks
     }
 }