fix!: support null as option value (#221)

BREAKING-CHANGE: serialize options as JSON instead of TOML
2026-01-31 07:01:05 +00:00 · 2023-05-01 05:23:17 +02:00
parent 2f5577e464
commit 379687c814
7 changed files with 182 additions and 86 deletions
--- a/src/main/kotlin/app/revanced/utils/Options.kt
+++ b/src/main/kotlin/app/revanced/utils/Options.kt
@@ -0,0 +1,103 @@
+package app.revanced.utils
+
+import app.revanced.cli.command.PatchList
+import app.revanced.cli.logging.CliLogger
+import app.revanced.patcher.extensions.PatchExtensions.options
+import app.revanced.patcher.extensions.PatchExtensions.patchName
+import app.revanced.patcher.patch.NoSuchOptionException
+import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
+import java.io.File
+
+
+internal object Options {
+    private var mapper = jacksonObjectMapper()
+
+    /**
+     * Serializes the options for the patches in the list.
+     *
+     * @param patches The list of patches to serialize.
+     * @param prettyPrint Whether to pretty print the JSON.
+     * @return The JSON string containing the options.
+     * @see PatchList
+     */
+    fun serialize(patches: PatchList, prettyPrint: Boolean = false): String = patches
+        .filter { it.options?.any() == true }
+        .map { patch ->
+            PatchOption(
+                patch.patchName,
+                patch.options!!.map { option -> PatchOption.Option(option.key, option.value) }
+            )
+        }.let {
+            if (prettyPrint)
+                mapper.writerWithDefaultPrettyPrinter().writeValueAsString(it)
+            else
+                mapper.writeValueAsString(it)
+        }
+
+    /**
+     * Deserializes the options for the patches in the list.
+     *
+     * @param json The JSON string containing the options.
+     * @return The list of [PatchOption]s.
+     * @see PatchOption
+     * @see PatchList
+     */
+    @Suppress("MemberVisibilityCanBePrivate")
+    fun deserialize(json: String): Array<PatchOption> = mapper.readValue(json, Array<PatchOption>::class.java)
+
+    /**
+     * Sets the options for the patches in the list.
+     *
+     * @param json The JSON string containing the options.
+     * @param logger The logger to use for logging.
+     */
+    fun PatchList.setOptions(json: String, logger: CliLogger? = null) {
+        filter { it.options?.any() == true }.let { patches ->
+            if (patches.isEmpty()) return
+
+            val patchOptions = deserialize(json)
+
+            patches.forEach { patch ->
+                patchOptions.find { option -> option.patchName == patch.patchName }?.let {
+                    it.options.forEach { option ->
+                        try {
+                            patch.options?.set(option.key, option.value)
+                                ?: logger?.warn("${patch.patchName} has no options")
+                        } catch (e: NoSuchOptionException) {
+                            logger?.error(e.message ?: "Unknown error")
+                        }
+                    }
+                }
+            }
+        }
+    }
+
+    /**
+     * Sets the options for the patches in the list.
+     *
+     * @param file The file containing the JSON string containing the options.
+     * @param logger The logger to use for logging.
+     * @see setOptions
+     */
+    fun PatchList.setOptions(file: File, logger: CliLogger? = null) = setOptions(file.readText(), logger)
+
+    /**
+     * Data class for a patch and its [Option]s.
+     *
+     * @property patchName The name of the patch.
+     * @property options The [Option]s for the patch.
+     */
+    internal data class PatchOption(
+        val patchName: String,
+        val options: List<Option>
+    ) {
+
+        /**
+         * Data class for patch option.
+         *
+         * @property key The name of the option.
+         * @property value The value of the option.
+         */
+        internal data class Option(val key: String, val value: Any?)
+    }
+}