refactor: abstract settings patch (#1109)

Co-authored-by: oSumAtrIX <johan.melkonyan1@web.de>

src/main/kotlin/app/revanced/patches/shared/settings/preference/BasePreference.kt

@@ -1,6 +1,6 @@
-package app.revanced.patches.shared.settings
+package app.revanced.patches.shared.settings.preference
 
-import app.revanced.patches.shared.settings.impl.StringResource
+import app.revanced.patches.shared.settings.preference.impl.StringResource
 import org.w3c.dom.Document
 import org.w3c.dom.Element
 

src/main/kotlin/app/revanced/patches/shared/settings/preference/BaseResource.kt

@@ -1,4 +1,4 @@
-package app.revanced.patches.shared.settings
+package app.revanced.patches.shared.settings.preference
 
 import org.w3c.dom.Document
 import org.w3c.dom.Element

src/main/kotlin/app/revanced/patches/shared/settings/preference/ComponentsExtensions.kt

@@ -1,6 +1,6 @@
-package app.revanced.patches.shared.settings
+package app.revanced.patches.shared.settings.preference
 
-import app.revanced.patches.shared.settings.impl.StringResource
+import app.revanced.patches.shared.settings.preference.impl.StringResource
 import org.w3c.dom.Element
 import org.w3c.dom.Node
 

src/main/kotlin/app/revanced/patches/shared/settings/preference/IPreference.kt

@@ -1,6 +1,6 @@
-package app.revanced.patches.shared.settings
+package app.revanced.patches.shared.settings.preference
 
-import app.revanced.patches.shared.settings.impl.StringResource
+import app.revanced.patches.shared.settings.preference.impl.StringResource
 
 /**
  * Preference

src/main/kotlin/app/revanced/patches/shared/settings/preference/IResource.kt

@@ -1,4 +1,4 @@
-package app.revanced.patches.shared.settings
+package app.revanced.patches.shared.settings.preference
 
 /**
  * Resource

src/main/kotlin/app/revanced/patches/shared/settings/preference/SummaryType.kt

@@ -1,4 +1,4 @@
-package app.revanced.patches.shared.settings
+package app.revanced.patches.shared.settings.preference
 
 enum class SummaryType(val type: String) {
     DEFAULT("summary"), ON("summaryOn"), OFF("summaryOff")

src/main/kotlin/app/revanced/patches/shared/settings/preference/impl/ArrayResource.kt

@@ -1,7 +1,7 @@
-package app.revanced.patches.shared.settings.impl
+package app.revanced.patches.shared.settings.preference.impl
 
-import app.revanced.patches.shared.settings.BaseResource
-import app.revanced.patches.shared.settings.IResource
+import app.revanced.patches.shared.settings.preference.BaseResource
+import app.revanced.patches.shared.settings.preference.IResource
 import org.w3c.dom.Document
 import org.w3c.dom.Element
 

src/main/kotlin/app/revanced/patches/shared/settings/preference/impl/InputType.kt

@@ -1,4 +1,4 @@
-package app.revanced.patches.shared.settings.impl
+package app.revanced.patches.shared.settings.preference.impl
 
 enum class InputType(val type: String) {
     STRING("text"),

src/main/kotlin/app/revanced/patches/shared/settings/preference/impl/ListPreference.kt

@@ -1,9 +1,9 @@
-package app.revanced.patches.shared.settings.impl
+package app.revanced.patches.shared.settings.preference.impl
 
-import app.revanced.patches.shared.settings.BasePreference
-import app.revanced.patches.shared.settings.IResource
-import app.revanced.patches.shared.settings.addDefault
-import app.revanced.patches.shared.settings.addSummary
+import app.revanced.patches.shared.settings.preference.BasePreference
+import app.revanced.patches.shared.settings.preference.IResource
+import app.revanced.patches.shared.settings.preference.addDefault
+import app.revanced.patches.shared.settings.preference.addSummary
 import org.w3c.dom.Document
 import org.w3c.dom.Element
 

src/main/kotlin/app/revanced/patches/shared/settings/preference/impl/Preference.kt

@@ -1,8 +1,8 @@
-package app.revanced.patches.shared.settings.impl
+package app.revanced.patches.shared.settings.preference.impl
 
-import app.revanced.patches.shared.settings.BasePreference
-import app.revanced.patches.shared.settings.IResource
-import app.revanced.patches.shared.settings.addSummary
+import app.revanced.patches.shared.settings.preference.BasePreference
+import app.revanced.patches.shared.settings.preference.IResource
+import app.revanced.patches.shared.settings.preference.addSummary
 import org.w3c.dom.Document
 import org.w3c.dom.Element
 

src/main/kotlin/app/revanced/patches/shared/settings/preference/impl/PreferenceCategory.kt

@@ -1,7 +1,7 @@
-package app.revanced.patches.shared.settings.impl
+package app.revanced.patches.shared.settings.preference.impl
 
-import app.revanced.patches.shared.settings.BasePreference
-import app.revanced.patches.shared.settings.IResource
+import app.revanced.patches.shared.settings.preference.BasePreference
+import app.revanced.patches.shared.settings.preference.IResource
 import org.w3c.dom.Document
 import org.w3c.dom.Element
 

src/main/kotlin/app/revanced/patches/shared/settings/preference/impl/PreferenceScreen.kt

@@ -1,8 +1,8 @@
-package app.revanced.patches.shared.settings.impl
+package app.revanced.patches.shared.settings.preference.impl
 
-import app.revanced.patches.shared.settings.BasePreference
-import app.revanced.patches.shared.settings.IResource
-import app.revanced.patches.shared.settings.addSummary
+import app.revanced.patches.shared.settings.preference.BasePreference
+import app.revanced.patches.shared.settings.preference.IResource
+import app.revanced.patches.shared.settings.preference.addSummary
 import org.w3c.dom.Document
 import org.w3c.dom.Element
 

src/main/kotlin/app/revanced/patches/shared/settings/preference/impl/StringResource.kt

@@ -1,7 +1,7 @@
-package app.revanced.patches.shared.settings.impl
+package app.revanced.patches.shared.settings.preference.impl
 
-import app.revanced.patches.shared.settings.BaseResource
-import app.revanced.patches.shared.settings.IResource
+import app.revanced.patches.shared.settings.preference.BaseResource
+import app.revanced.patches.shared.settings.preference.IResource
 import org.w3c.dom.Document
 import org.w3c.dom.Element
 

src/main/kotlin/app/revanced/patches/shared/settings/preference/impl/SwitchPreference.kt

@@ -1,10 +1,10 @@
-package app.revanced.patches.shared.settings.impl
+package app.revanced.patches.shared.settings.preference.impl
 
-import app.revanced.patches.shared.settings.*
-import app.revanced.patches.shared.settings.BasePreference
-import app.revanced.patches.shared.settings.IResource
-import app.revanced.patches.shared.settings.addDefault
-import app.revanced.patches.shared.settings.addSummary
+import app.revanced.patches.shared.settings.preference.BasePreference
+import app.revanced.patches.shared.settings.preference.IResource
+import app.revanced.patches.shared.settings.preference.addDefault
+import app.revanced.patches.shared.settings.preference.addSummary
+import app.revanced.patches.shared.settings.preference.SummaryType
 import org.w3c.dom.Document
 import org.w3c.dom.Element
 

src/main/kotlin/app/revanced/patches/shared/settings/preference/impl/TextPreference.kt

@@ -1,9 +1,9 @@
-package app.revanced.patches.shared.settings.impl
+package app.revanced.patches.shared.settings.preference.impl
 
-import app.revanced.patches.shared.settings.BasePreference
-import app.revanced.patches.shared.settings.IResource
-import app.revanced.patches.shared.settings.addDefault
-import app.revanced.patches.shared.settings.addSummary
+import app.revanced.patches.shared.settings.preference.BasePreference
+import app.revanced.patches.shared.settings.preference.IResource
+import app.revanced.patches.shared.settings.preference.addDefault
+import app.revanced.patches.shared.settings.preference.addSummary
 import org.w3c.dom.Document
 import org.w3c.dom.Element
 

src/main/kotlin/app/revanced/patches/shared/settings/resource/patch/AbstractSettingsResourcePatch.kt

@@ -0,0 +1,124 @@
+package app.revanced.patches.shared.settings.resource.patch
+
+import app.revanced.patcher.data.DomFileEditor
+import app.revanced.patcher.data.ResourceContext
+import app.revanced.patcher.patch.PatchResult
+import app.revanced.patcher.patch.PatchResultSuccess
+import app.revanced.patcher.patch.ResourcePatch
+import app.revanced.patches.shared.settings.preference.BasePreference
+import app.revanced.patches.shared.settings.preference.IResource
+import app.revanced.patches.shared.settings.preference.addPreference
+import app.revanced.patches.shared.settings.preference.addResource
+import app.revanced.patches.shared.settings.preference.impl.ArrayResource
+import app.revanced.patches.shared.settings.preference.impl.StringResource
+import app.revanced.util.resources.ResourceUtils
+import app.revanced.util.resources.ResourceUtils.copyResources
+import org.w3c.dom.Node
+
+/**
+ * Abstract settings resource patch
+ *
+ * @param preferenceFileName Name of the settings preference xml file
+ * @param sourceDirectory Source directory to copy the preference template from
+ */
+abstract class AbstractSettingsResourcePatch(
+    private val preferenceFileName: String,
+    private val sourceDirectory: String,
+) : ResourcePatch {
+    override fun execute(context: ResourceContext): PatchResult {
+        /* copy preference template from source dir */
+        context.copyResources(
+            sourceDirectory,
+            ResourceUtils.ResourceGroup(
+                "xml", "$preferenceFileName.xml"
+            )
+        )
+
+        /* prepare xml editors */
+        stringsEditor = context.xmlEditor["res/values/strings.xml"]
+        arraysEditor = context.xmlEditor["res/values/arrays.xml"]
+        revancedPreferencesEditor = context.xmlEditor["res/xml/$preferenceFileName.xml"]
+
+        return PatchResultSuccess()
+    }
+
+    internal companion object {
+        private var revancedPreferenceNode: Node? = null
+        private var stringsNode: Node? = null
+        private var arraysNode: Node? = null
+
+        private var strings = mutableListOf<StringResource>()
+
+        private var revancedPreferencesEditor: DomFileEditor? = null
+            set(value) {
+                field = value
+                revancedPreferenceNode = value.getNode("PreferenceScreen")
+            }
+        private var stringsEditor: DomFileEditor? = null
+            set(value) {
+                field = value
+                stringsNode = value.getNode("resources")
+            }
+        private var arraysEditor: DomFileEditor? = null
+            set(value) {
+                field = value
+                arraysNode = value.getNode("resources")
+            }
+
+        /**
+         * Add a new string to the resources.
+         *
+         * @param identifier The key of the string.
+         * @param value The value of the string.
+         * @throws IllegalArgumentException if the string already exists.
+         */
+        fun addString(identifier: String, value: String, formatted: Boolean) =
+            StringResource(identifier, value, formatted).include()
+
+        /**
+         * Add an array to the resources.
+         *
+         * @param arrayResource The array resource to add.
+         */
+        fun addArray(arrayResource: ArrayResource) =
+            arraysNode!!.addResource(arrayResource)
+
+        /**
+         * Add a preference to the settings.
+         *
+         * @param preference The preference to add.
+         */
+        fun addPreference(preference: BasePreference) =
+            revancedPreferenceNode!!.addPreference(preference) { it.include() }
+
+        /**
+         * Add a new resource to the resources.
+         *
+         * @throws IllegalArgumentException if the resource already exists.
+         */
+        internal fun IResource.include() {
+            when (this) {
+                is StringResource -> {
+                    if (strings.any { it.name == name }) return
+                    strings.add(this)
+                }
+
+                is ArrayResource -> addArray(this)
+                else -> throw NotImplementedError("Unsupported resource type")
+            }
+        }
+
+        internal fun DomFileEditor?.getNode(tagName: String) = this!!.file.getElementsByTagName(tagName).item(0)
+    }
+
+    override fun close() {
+        // merge all strings, skip duplicates
+        strings.forEach {
+            stringsNode!!.addResource(it)
+        }
+
+        revancedPreferencesEditor?.close()
+        stringsEditor?.close()
+        arraysEditor?.close()
+    }
+}

src/main/kotlin/app/revanced/patches/shared/settings/util/AbstractPreferenceScreen.kt

@@ -0,0 +1,89 @@
+package app.revanced.patches.shared.settings.util
+
+import app.revanced.patches.shared.settings.preference.BasePreference
+import app.revanced.patches.shared.settings.preference.impl.PreferenceCategory
+import app.revanced.patches.shared.settings.preference.impl.PreferenceScreen
+import app.revanced.patches.shared.settings.preference.impl.StringResource
+import java.io.Closeable
+
+internal abstract class AbstractPreferenceScreen(
+    private val root: MutableList<Screen> = mutableListOf()
+) : Closeable {
+
+    override fun close() {
+        if (root.isEmpty())
+            return
+
+        for (preference in root.sortedBy { it.title }) {
+            commit(preference.transform())
+        }
+    }
+
+    /**
+     * Finalize and insert root preference into resource patch
+     */
+    abstract fun commit(screen: PreferenceScreen)
+
+    open inner class Screen(
+        key: String,
+        title: String,
+        val summary: String? = null,
+        preferences: MutableList<BasePreference> = mutableListOf(),
+        val categories: MutableList<Category> = mutableListOf()
+    ) : BasePreferenceCollection(key, title, preferences) {
+        override fun transform(): PreferenceScreen {
+            return PreferenceScreen(
+                key,
+                StringResource("${key}_title", title),
+                 preferences.sortedBy { it.title.value } +
+                         categories.sortedBy { it.title }.map { it.transform() },
+                summary?.let { summary ->
+                    StringResource("${key}_summary", summary)
+                }
+            )
+        }
+
+        private fun ensureScreenInserted() {
+            // Add to screens if not yet done
+            if(!this@AbstractPreferenceScreen.root.contains(this))
+                this@AbstractPreferenceScreen.root.add(this)
+        }
+
+        fun addPreferences(vararg preferences: BasePreference) {
+            ensureScreenInserted()
+            this.preferences.addAll(preferences)
+        }
+
+        open inner class Category(
+            key: String,
+            title: String,
+            preferences: MutableList<BasePreference> = mutableListOf()
+        ): BasePreferenceCollection(key, title, preferences) {
+            override fun transform(): PreferenceCategory {
+                return PreferenceCategory(
+                    key,
+                    StringResource("${key}_title", title),
+                    preferences.sortedBy { it.title.value }
+                )
+            }
+
+            fun addPreferences(vararg preferences: BasePreference) {
+                ensureScreenInserted()
+
+                // Add to categories if not yet done
+                if(!this@Screen.categories.contains(this))
+                    this@Screen.categories.add(this)
+
+                this.preferences.addAll(preferences)
+            }
+        }
+    }
+
+    abstract class BasePreferenceCollection(
+        val key: String,
+        val title: String,
+        val preferences: MutableList<BasePreference> = mutableListOf()
+    ) {
+        abstract fun transform(): BasePreference
+    }
+}