chore(release): 2.16.1 [skip ci]

## [2.16.1](https://github.com/revanced/revanced-cli/compare/v2.16.0...v2.16.1) (2022-11-22)

.github/ISSUE_TEMPLATE/bug-issue.yml

@@ -59,3 +59,15 @@ body:
       description: Add additional context here.
     validations:
       required: false
+  - type: checkboxes
+    id: acknowledgements
+    attributes:
+      label: Acknowledgements
+      description: Your issue will be closed if you haven't done these steps.
+      options:
+        - label: I have searched the existing issues and this is a new and no duplicate or related to another open issue.
+          required: true
+        - label: I have written a short but informative title.
+          required: true
+        - label: I filled out all of the requested information in this issue properly.
+          required: true

.github/ISSUE_TEMPLATE/feature-issue.yml

@@ -43,4 +43,16 @@ body:
       label: Additional context
       description: Add additional context here.
     validations:
-      required: false
+      required: false
+  - type: checkboxes
+    id: acknowledgements
+    attributes:
+      label: Acknowledgements
+      description: Your issue will be closed if you haven't done these steps.
+      options:
+        - label: I have searched the existing issues and this is a new and no duplicate or related to another open issue.
+          required: true
+        - label: I have written a short but informative title.
+          required: true
+        - label: I filled out all of the requested information in this issue properly.
+          required: true

.github/workflows/release.yml

@@ -15,17 +15,17 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
       - name: Setup JDK
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v3
         with:
           java-version: '17'
-          distribution: 'adopt'
+          distribution: 'temurin'
           cache: gradle
       - name: Setup Node.js
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: "lts/*"
       - name: Build with Gradle

.gitignore

@@ -111,4 +111,8 @@ gradle-app.setting
 .gradletasknamecache
 
 # # Work around https://youtrack.jetbrains.com/issue/IDEA-116898
-# gradle/wrapper/gradle-wrapper.properties
+# gradle/wrapper/gradle-wrapper.properties
+
+revanced-cache/
+options.toml
+.idea/vcs.xml

.idea/misc.xml

@@ -4,6 +4,10 @@
   <component name="FrameworkDetectionExcludesConfiguration">
     <file type="web" url="file://$PROJECT_DIR$" />
   </component>
+  <component name="PWA">
+    <option name="enabled" value="true" />
+    <option name="wasEnabledAtLeastOnce" value="true" />
+  </component>
   <component name="ProjectRootManager" version="2" languageLevel="JDK_17" default="true" project-jdk-name="azul-17" project-jdk-type="JavaSDK">
     <output url="file://$PROJECT_DIR$/out" />
   </component>

.idea/vcs.xml

@@ -8,7 +8,5 @@
   </component>
   <component name="VcsDirectoryMappings">
     <mapping directory="$PROJECT_DIR$" vcs="Git" />
-    <mapping directory="$PROJECT_DIR$/../revanced-patcher" vcs="Git" />
-    <mapping directory="$PROJECT_DIR$/../revanced-patches" vcs="Git" />
   </component>
 </project>

CHANGELOG.md

@@ -1,3 +1,68 @@
+## [2.16.1](https://github.com/revanced/revanced-cli/compare/v2.16.0...v2.16.1) (2022-11-22)
+
+# [2.16.0](https://github.com/revanced/revanced-cli/compare/v2.15.1...v2.16.0) (2022-11-20)
+
+
+### Features
+
+* do not warn on incompatible packages ([39e377b](https://github.com/revanced/revanced-cli/commit/39e377bc485e2892422e9712d30e6ff665856ac1))
+
+## [2.15.1](https://github.com/revanced/revanced-cli/compare/v2.15.0...v2.15.1) (2022-11-18)
+
+# [2.15.0](https://github.com/revanced/revanced-cli/compare/v2.14.0...v2.15.0) (2022-10-31)
+
+
+### Bug Fixes
+
+* **gitignore:** ignore `options.toml` ([#158](https://github.com/revanced/revanced-cli/issues/158)) ([7be9af0](https://github.com/revanced/revanced-cli/commit/7be9af0942de2a834b9e57403d46263b65f1a422))
+
+
+### Features
+
+* use `am` instead of `monkey` to launch the app ([#159](https://github.com/revanced/revanced-cli/issues/159)) ([6a35cf7](https://github.com/revanced/revanced-cli/commit/6a35cf7ea46a4474120626ce03d28490cc96bf07))
+
+# [2.14.0](https://github.com/revanced/revanced-cli/compare/v2.13.0...v2.14.0) (2022-10-05)
+
+
+### Bug Fixes
+
+* escape quotation mark in string ([6e21d81](https://github.com/revanced/revanced-cli/commit/6e21d81964e8160e06ffda7051dd484e4aaaa432))
+
+
+### Features
+
+* handle unmounting deleted files ([#148](https://github.com/revanced/revanced-cli/issues/148)) ([3a733e5](https://github.com/revanced/revanced-cli/commit/3a733e513717799ca0e32327e5b8be043680c556))
+* unmount all occurrences in `/proc/mounts` ([#131](https://github.com/revanced/revanced-cli/issues/131)) ([4f4e1f9](https://github.com/revanced/revanced-cli/commit/4f4e1f9834bf28d9be2efd4fd7bae19951b85258))
+
+# [2.13.0](https://github.com/revanced/revanced-cli/compare/v2.12.0...v2.13.0) (2022-10-01)
+
+
+### Features
+
+* check, if input file exists ([b6dff6d](https://github.com/revanced/revanced-cli/commit/b6dff6d832de4a513a6d86b0a59b2458eddd23c2))
+
+# [2.12.0](https://github.com/revanced/revanced-cli/compare/v2.11.2...v2.12.0) (2022-09-26)
+
+
+### Features
+
+* remove unused option `-r` ([467d838](https://github.com/revanced/revanced-cli/commit/467d8387e646c88d24a30406a5b2e84065ef4d54))
+
+## [2.11.2](https://github.com/revanced/revanced-cli/compare/v2.11.1...v2.11.2) (2022-09-23)
+
+## [2.11.1](https://github.com/revanced/revanced-cli/compare/v2.11.0...v2.11.1) (2022-09-21)
+
+# [2.11.0](https://github.com/revanced/revanced-cli/compare/v2.10.2...v2.11.0) (2022-09-20)
+
+
+### Features
+
+* section `acknowledgements` for issue templates ([0e3ecc3](https://github.com/revanced/revanced-cli/commit/0e3ecc3a51540b71072ae0be0eb94d115a5b1f92))
+
+## [2.10.2](https://github.com/revanced/revanced-cli/compare/v2.10.1...v2.10.2) (2022-09-18)
+
+## [2.10.1](https://github.com/revanced/revanced-cli/compare/v2.10.0...v2.10.1) (2022-09-09)
+
 # [2.10.0](https://github.com/revanced/revanced-cli/compare/v2.9.10...v2.10.0) (2022-09-08)
 
 

build.gradle.kts

@@ -25,8 +25,8 @@ repositories {
 dependencies {
     implementation(kotlin("reflect"))
 
-    implementation("app.revanced:revanced-patcher:4.2.3")
-    implementation("info.picocli:picocli:4.6.3")
+    implementation("app.revanced:revanced-patcher:6.1.0")
+    implementation("info.picocli:picocli:4.7.0")
     implementation("com.android.tools.build:apksig:7.2.1")
     implementation("com.github.revanced:jadb:master-SNAPSHOT") // updated fork
     implementation("org.bouncycastle:bcpkix-jdk15on:1.70")

gradle.properties

@@ -1,2 +1,2 @@
 kotlin.code.style = official
-version = 2.10.0
+version = 2.16.1

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

@@ -10,7 +10,7 @@ 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.impl.JarPatchBundle
+import app.revanced.patcher.util.patch.PatchBundle
 import app.revanced.utils.OptionsLoader
 import app.revanced.utils.adb.Adb
 import picocli.CommandLine.*
@@ -92,9 +92,6 @@ internal object MainCommand : Runnable {
         @Option(names = ["-i", "--include"], description = ["Include patches"])
         var includedPatches = arrayOf<String>()
 
-        @Option(names = ["-r", "--resource-patcher"], description = ["Disable patching resources"])
-        var disableResourcePatching: Boolean = false
-
         @Option(names = ["--experimental"], description = ["Disable patch version compatibility patch"])
         var experimental: Boolean = false
 
@@ -134,16 +131,15 @@ internal object MainCommand : Runnable {
         val outputFile = File(pArgs.outputPath) // the file to write to
 
         val allPatches = args.patchArgs!!.patchBundles.flatMap { bundle ->
-            JarPatchBundle(bundle).loadPatches()
+            PatchBundle.Jar(bundle).loadPatches()
         }
 
         OptionsLoader.init(args.patchArgs!!.options, allPatches)
 
         val patcher = app.revanced.patcher.Patcher(
             PatcherOptions(
-                args.inputFile,
+                args.inputFile.also { if (!it.exists()) return logger.error("Input file ${args.inputFile} does not exist.") },
                 pArgs.cacheDirectory,
-                !pArgs.disableResourcePatching,
                 pArgs.aaptPath,
                 pArgs.cacheDirectory,
                 PatcherLogger
@@ -152,7 +148,7 @@ internal object MainCommand : Runnable {
 
         // prepare adb
         val adb: Adb? = args.deploy?.let {
-            Adb(outputFile, patcher.data.packageMetadata.packageName, args.deploy!!, !pArgs.mount)
+            Adb(outputFile, patcher.context.packageMetadata.packageName, args.deploy!!, !pArgs.mount)
         }
 
         val patchedFile = File(pArgs.cacheDirectory).resolve("${outputFile.nameWithoutExtension}_raw.apk")
@@ -210,26 +206,21 @@ internal object MainCommand : Runnable {
     }
 
     private fun uninstall() {
-        // temporarily get package name using Patcher method
-        // fix: abstract options in patcher
-        val patcher = app.revanced.patcher.Patcher(
-            PatcherOptions(
-                args.inputFile,
-                "uninstaller-cache",
+        val adb: Adb? = args.deploy?.let {
+            Adb(
+                File("placeholder_file"),
+                app.revanced.patcher.Patcher(PatcherOptions(args.inputFile, "")).context.packageMetadata.packageName,
+                args.deploy!!,
                 false
             )
-        )
-        File("uninstaller-cache").deleteRecursively()
-
-        val adb: Adb? = args.deploy?.let {
-            Adb(File("placeholder_file"), patcher.data.packageMetadata.packageName, args.deploy!!, false)
         }
         adb?.uninstall()
     }
 
     private fun printListOfPatches() {
         val logged = mutableListOf<String>()
-        for (patchBundlePath in args.patchArgs?.patchBundles!!) for (patch in JarPatchBundle(patchBundlePath).loadPatches()) {
+        for (patchBundlePath in args.patchArgs?.patchBundles!!) for (patch in PatchBundle.Jar(patchBundlePath)
+            .loadPatches()) {
             if (patch.patchName in logged) continue
             for (compatiblePackage in patch.compatiblePackages!!) {
                 val packageEntryStr = buildString {

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

@@ -2,7 +2,7 @@ package app.revanced.cli.patcher
 
 import app.revanced.cli.command.MainCommand.args
 import app.revanced.cli.command.MainCommand.logger
-import app.revanced.patcher.data.Data
+import app.revanced.patcher.data.Context
 import app.revanced.patcher.patch.Patch
 import app.revanced.utils.filesystem.ZipFileSystemUtils
 import app.revanced.utils.patcher.addPatchesFiltered
@@ -12,9 +12,12 @@ import java.io.File
 import java.nio.file.Files
 
 internal object Patcher {
-    internal fun start(patcher: app.revanced.patcher.Patcher, output: File, allPatches: List<Class<out Patch<Data>>>) {
+    internal fun start(
+        patcher: app.revanced.patcher.Patcher,
+        output: File,
+        allPatches: List<Class<out Patch<Context>>>
+    ) {
         val inputFile = args.inputFile
-        val args = args.patchArgs?.patchingArgs!!
 
         // merge files like necessary integrations
         patcher.mergeFiles()
@@ -35,10 +38,10 @@ internal object Patcher {
                 outputFileSystem.write(it.name, it.stream.readAllBytes())
             }
 
-            if (!args.disableResourcePatching) {
+            result.resourceFile?.let {
                 logger.info("Writing resources...")
 
-                ZipFileSystemUtils(result.resourceFile!!).use { resourceFileSystem ->
+                ZipFileSystemUtils(it).use { resourceFileSystem ->
                     val resourceFiles = resourceFileSystem.getFile(File.separator)
                     outputFileSystem.writePathRecursively(resourceFiles)
                 }

src/main/kotlin/app/revanced/utils/OptionsLoader.kt

@@ -1,20 +1,19 @@
 package app.revanced.utils
 
 import app.revanced.cli.command.MainCommand.logger
-import app.revanced.patcher.data.Data
+import app.revanced.patcher.Patcher
+import app.revanced.patcher.data.Context
 import app.revanced.patcher.extensions.PatchExtensions.options
 import app.revanced.patcher.extensions.PatchExtensions.patchName
 import app.revanced.patcher.patch.Patch
-import cc.ekblad.toml.encodeTo
+import cc.ekblad.toml.encodeToString
 import cc.ekblad.toml.model.TomlValue
 import cc.ekblad.toml.serialization.from
 import cc.ekblad.toml.tomlMapper
 import java.io.File
 
-private typealias PatchList = List<Class<out Patch<Data>>>
-private typealias OptionsMap = Map<String, Map<String, Any>>
-
-private const val NULL = "null"
+private typealias PatchList = List<Class<out Patch<Context>>>
+private typealias OptionsMap = MutableMap<String, MutableMap<String, Any>>
 
 object OptionsLoader {
     @JvmStatic
@@ -23,12 +22,9 @@ object OptionsLoader {
     @JvmStatic
     fun init(file: File, patches: PatchList) {
         if (!file.exists()) file.createNewFile()
-        val path = file.toPath()
-        val map = mapper.decodeWithDefaults(
-            generateDefaults(patches),
-            TomlValue.from(path)
-        ).also { mapper.encodeTo(path, it) }
+        val map = mapper.decodeWithDefaults(generateDefaults(patches), TomlValue.from(file.toPath()))
         readAndSet(map, patches)
+        save(map, file)
     }
 
     private fun readAndSet(map: OptionsMap, patches: PatchList) {
@@ -36,27 +32,46 @@ object OptionsLoader {
             val patch = patches.find { it.patchName == patchName } ?: continue
             val patchOptions = patch.options ?: continue
             for ((key, value) in options) {
+                if (value == "null") { // backwards compatibility, subject to removal
+                    options.remove(key)
+                    continue
+                }
                 try {
-                    patchOptions[key] = value.let {
-                        if (it == NULL) null else it
-                    }
+                    patchOptions[key] = value
                 } catch (e: Exception) {
-                    logger.warn("Error while setting option $key for patch $patchName: ${e.message}")
+                    logger.error("Error while setting option $key for patch $patchName: ${e.message}")
                     e.printStackTrace()
                 }
             }
         }
     }
 
+    private fun save(map: OptionsMap, file: File) {
+        val toml = mapper.encodeToString(map)
+        file.writeText(
+            """
+                # A list of options for each patch.
+                # This file does not contain all options by default.
+                # Run the CLI with the "--list --with-options" flags to see all available options.
+                # You can also run the CLI with the aforementioned flags and a patch name to see all available options for that patch.
+                # To set an option, add a line with the format "option = value" or set the value if the option already exists.
+                # To reset an option to its default value, delete the line.
+                # To reset all options to their default values, delete this file.
+                # 
+                # This file was generated by ReVanced Patcher version ${Patcher.version}.
+            """.trimIndent() + "\n\n$toml"
+        )
+    }
+
     private fun generateDefaults(patches: PatchList) = buildMap {
         for (patch in patches) {
             val options = patch.options ?: continue
             if (!options.iterator().hasNext()) continue
             put(patch.patchName, buildMap {
                 for (option in options) {
-                    put(option.key, option.value ?: NULL)
+                    put(option.key, option.value ?: continue)
                 }
-            })
+            } as MutableMap)
         }
-    }
+    } as MutableMap
 }

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

@@ -9,7 +9,7 @@ internal object Constants {
     internal const val COMMAND_PID_OF = "pidof -s"
     internal const val COMMAND_CREATE_DIR = "mkdir -p"
     internal const val COMMAND_LOGCAT = "logcat -c && logcat | grep AndroidRuntime"
-    internal const val COMMAND_RESTART = "monkey -p $PLACEHOLDER 1 && kill ${'$'}($COMMAND_PID_OF $PLACEHOLDER)"
+    internal const val COMMAND_RESTART = "pm resolve-activity --brief $PLACEHOLDER | tail -n 1 | xargs am start -n && kill ${'$'}($COMMAND_PID_OF $PLACEHOLDER)"
 
     // default mount file name
     private const val NAME_MOUNT_SCRIPT = "mount_revanced_$PLACEHOLDER.sh"
@@ -35,7 +35,7 @@ internal object Constants {
 
     // unmount command
     internal const val COMMAND_UMOUNT =
-        "stock_path=${'$'}( pm path $PLACEHOLDER | grep base | sed 's/package://g' ) && umount -l ${'$'}stock_path"
+        "grep $PLACEHOLDER /proc/mounts | while read -r line; do echo ${'$'}line | cut -d \" \" -f 2 | sed 's/apk.*/apk/' | xargs -r umount -l; done"
 
     // install mount script & set permissions
     internal const val COMMAND_INSTALL_MOUNT = "mv $PATH_INIT_PUSH $PATH_MOUNT && $COMMAND_CHMOD_MOUNT $PATH_MOUNT"

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

@@ -4,18 +4,17 @@ 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.Data
+import app.revanced.patcher.data.Context
 import app.revanced.patcher.extensions.PatchExtensions.compatiblePackages
-import app.revanced.patcher.extensions.PatchExtensions.deprecated
 import app.revanced.patcher.extensions.PatchExtensions.include
 import app.revanced.patcher.extensions.PatchExtensions.patchName
 import app.revanced.patcher.patch.Patch
 
-fun Patcher.addPatchesFiltered(allPatches: List<Class<out Patch<Data>>>) {
-    val packageName = this.data.packageMetadata.packageName
-    val packageVersion = this.data.packageMetadata.packageVersion
+fun Patcher.addPatchesFiltered(allPatches: List<Class<out Patch<Context>>>) {
+    val packageName = this.context.packageMetadata.packageName
+    val packageVersion = this.context.packageMetadata.packageVersion
 
-    val includedPatches = mutableListOf<Class<out Patch<Data>>>()
+    val includedPatches = mutableListOf<Class<out Patch<Context>>>()
     allPatches.forEach patchLoop@{ patch ->
         val compatiblePackages = patch.compatiblePackages
         val patchName = patch.patchName
@@ -32,16 +31,10 @@ fun Patcher.addPatchesFiltered(allPatches: List<Class<out Patch<Data>>>) {
             return@patchLoop
         }
 
-        patch.deprecated?.let { (reason, replacement) ->
-            logger.warn("$prefix: deprecated: $reason")
-            if (replacement != null) logger.warn("Either use ${replacement.java.patchName} instead or include it manually")
-            return@patchLoop
-        }
-
         if (compatiblePackages == null) logger.warn("$prefix: Missing compatibility annotation. Continuing.")
         else {
             if (!compatiblePackages.any { it.name == packageName }) {
-                logger.warn("$prefix: incompatible with $packageName. This patch is only compatible with ${
+                logger.trace("$prefix: Incompatible with $packageName. This patch is only compatible with ${
                     compatiblePackages.joinToString(
                         ", "
                     ) { it.name }
@@ -53,7 +46,7 @@ fun Patcher.addPatchesFiltered(allPatches: List<Class<out Patch<Data>>>) {
                 val compatibleWith = compatiblePackages.joinToString(";") { _package ->
                     "${_package.name}: ${_package.versions.joinToString(", ")}"
                 }
-                logger.warn("$prefix: incompatible with version $packageVersion. This patch is only compatible with version $compatibleWith")
+                logger.warn("$prefix: Incompatible with version $packageVersion. This patch is only compatible with version $compatibleWith")
                 return@patchLoop
             }
         }
@@ -66,7 +59,7 @@ fun Patcher.addPatchesFiltered(allPatches: List<Class<out Patch<Data>>>) {
 }
 
 fun Patcher.applyPatchesVerbose() {
-    this.applyPatches().forEach { (patch, result) ->
+    this.executePatches().forEach { (patch, result) ->
         if (result.isSuccess) {
             logger.info("$patch succeeded")
             return@forEach

src/main/kotlin/app/revanced/utils/signing/align/zip/structures/ZipEntry.kt

@@ -1,10 +1,6 @@
 package app.revanced.utils.signing.align.zip.structures
 
-import app.revanced.utils.signing.align.zip.getUShort
-import app.revanced.utils.signing.align.zip.putUInt
-import app.revanced.utils.signing.align.zip.putUShort
-import app.revanced.utils.signing.align.zip.readUIntLE
-import app.revanced.utils.signing.align.zip.readUShortLE
+import app.revanced.utils.signing.align.zip.*
 import java.io.DataInput
 import java.nio.ByteBuffer
 import java.nio.ByteOrder