refactor: abstract settings patch away from YouTube (#1103)

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

src/main/kotlin/app/revanced/patches/shared/fingerprints/WatchWhileActivityFingerprint.kt

@@ -0,0 +1,10 @@
+package app.revanced.patches.shared.fingerprints
+
+
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+
+object WatchWhileActivityFingerprint : MethodFingerprint(
+    customFingerprint = { methodDef ->
+        methodDef.definingClass.endsWith("WatchWhileActivity;") && methodDef.name == "<init>"
+    }
+)

src/main/kotlin/app/revanced/patches/shared/integrations/patch/AbstractIntegrationsPatch.kt

@@ -0,0 +1,66 @@
+package app.revanced.patches.shared.integrations.patch
+
+import app.revanced.patcher.annotation.Description
+import app.revanced.patcher.annotation.Version
+import app.revanced.patcher.data.BytecodeContext
+import app.revanced.patcher.extensions.addInstruction
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import app.revanced.patcher.patch.BytecodePatch
+import app.revanced.patcher.patch.PatchResult
+import app.revanced.patcher.patch.PatchResultError
+import app.revanced.patcher.patch.PatchResultSuccess
+import org.jf.dexlib2.iface.Method
+
+@Description("Applies mandatory patches to implement the ReVanced integrations into the application.")
+@Version("0.0.1")
+abstract class AbstractIntegrationsPatch(
+    private val integrationsDescriptor: String,
+    private val hooks: Iterable<IntegrationsFingerprint>
+) : BytecodePatch(hooks) {
+    /**
+     * [MethodFingerprint] for integrations.
+     *
+     * @param contextRegisterResolver A [RegisterResolver] to get the register.
+     * @see MethodFingerprint
+     */
+    abstract class IntegrationsFingerprint(
+        strings: Iterable<String>? = null,
+        customFingerprint: ((methodDef: Method) -> Boolean)? = null,
+        private val contextRegisterResolver: (Method) -> Int = object : RegisterResolver {}
+    ) : MethodFingerprint(strings = strings, customFingerprint = customFingerprint) {
+        fun invoke(integrationsDescriptor: String): PatchResult {
+            result?.mutableMethod?.let { method ->
+                val contextRegister = contextRegisterResolver(method)
+
+                method.addInstruction(
+                    0,
+                    "sput-object v$contextRegister, " +
+                            "$integrationsDescriptor->context:Landroid/content/Context;"
+                )
+            } ?: return PatchResultError("Could not find hook target fingerprint.")
+
+            return PatchResultSuccess()
+        }
+
+        interface RegisterResolver : (Method) -> Int {
+            override operator fun invoke(method: Method) = method.implementation!!.registerCount - 1
+        }
+    }
+
+    override fun execute(context: BytecodeContext): PatchResult {
+        if (context.findClass(integrationsDescriptor) == null) return MISSING_INTEGRATIONS
+
+        for (hook in hooks) hook.invoke(integrationsDescriptor).let {
+            if (it is PatchResultError) return it
+        }
+
+        return PatchResultSuccess()
+    }
+
+    private companion object {
+        val MISSING_INTEGRATIONS = PatchResultError(
+            "Integrations have not been merged yet. " +
+                    "This patch can not succeed without merging the integrations."
+        )
+    }
+}

src/main/kotlin/app/revanced/patches/shared/mapping/misc/patch/ResourceMappingPatch.kt

@@ -1,4 +1,4 @@
-package app.revanced.patches.shared.mapping.patch
+package app.revanced.patches.shared.mapping.misc.patch
 
 import app.revanced.patcher.annotation.Description
 import app.revanced.patcher.annotation.Name

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

@@ -0,0 +1,31 @@
+package app.revanced.patches.shared.settings
+
+import app.revanced.patches.shared.settings.impl.StringResource
+import org.w3c.dom.Document
+import org.w3c.dom.Element
+
+/**
+ * Base preference class for all preferences.
+ *
+ * @param key The key of the preference.
+ * @param title The title of the preference.
+ */
+internal abstract class BasePreference(
+    override val key: String,
+    override val title: StringResource,
+) : IPreference {
+
+    /**
+     * Serialize preference element to XML.
+     * Overriding methods should invoke super and operate on its return value.
+     * @param ownerDocument Target document to create elements from.
+     * @param resourceCallback Called when a resource has been processed.
+     */
+    open fun serialize(ownerDocument: Document, resourceCallback: ((IResource) -> Unit)? = null): Element {
+        return ownerDocument.createElement(tag).apply {
+            if(key.isNotEmpty())
+                setAttribute("android:key", key)
+            setAttribute("android:title", "@string/${title.also { resourceCallback?.invoke(it) }.name}")
+        }
+    }
+}

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

@@ -0,0 +1,26 @@
+package app.revanced.patches.shared.settings
+
+import org.w3c.dom.Document
+import org.w3c.dom.Element
+
+/**
+ * Base resource class for all resources.
+ *
+ * @param name The name of the resource.
+ */
+internal abstract class BaseResource(
+    override val name: String
+) : IResource {
+
+    /**
+     * Serialize resource element to XML.
+     * Overriding methods should invoke super and operate on its return value.
+     * @param ownerDocument Target document to create elements from.
+     * @param resourceCallback Called when a resource has been processed.
+     */
+    open fun serialize(ownerDocument: Document, resourceCallback: ((IResource) -> Unit)? = null): Element {
+        return ownerDocument.createElement(tag).apply {
+            setAttribute("name", name)
+        }
+    }
+}

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

@@ -0,0 +1,42 @@
+package app.revanced.patches.shared.settings
+
+import app.revanced.patches.shared.settings.impl.StringResource
+import org.w3c.dom.Element
+import org.w3c.dom.Node
+
+/**
+ * Add a resource node child
+ *
+ * @param resource The resource to add.
+ * @param resourceCallback Called when a resource has been processed.
+ */
+internal fun Node.addResource(resource: BaseResource, resourceCallback: ((IResource) -> Unit)? = null) {
+    appendChild(resource.serialize(ownerDocument, resourceCallback))
+}
+
+/**
+ * Add a preference node child to the settings.
+ *
+ * @param preference The preference to add.
+ * @param resourceCallback Called when a resource has been processed.
+ */
+internal fun Node.addPreference(preference: BasePreference, resourceCallback: ((IResource) -> Unit)? = null) {
+    appendChild(preference.serialize(ownerDocument, resourceCallback))
+}
+
+internal fun Element.addSummary(summaryResource: StringResource?, summaryType: SummaryType = SummaryType.DEFAULT) =
+    summaryResource?.let { summary ->
+        setAttribute("android:${summaryType.type}", "@string/${summary.name}")
+    }
+
+internal fun <T> Element.addDefault(default: T) {
+    default?.let {
+        setAttribute(
+            "android:defaultValue", when (it) {
+                is Boolean -> if (it) "true" else "false"
+                is String -> it
+                else -> throw IllegalArgumentException("Unsupported default value type: ${it::class.java.name}")
+            }
+        )
+    }
+}

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

@@ -0,0 +1,23 @@
+package app.revanced.patches.shared.settings
+
+import app.revanced.patches.shared.settings.impl.StringResource
+
+/**
+ * Preference
+ */
+internal interface IPreference {
+    /**
+     * Key of the preference.
+     */
+    val key: String
+
+    /**
+     * Title of the preference.
+     */
+    val title: StringResource
+
+    /**
+     * Tag name of the preference.
+     */
+    val tag: String
+}

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

@@ -0,0 +1,16 @@
+package app.revanced.patches.shared.settings
+
+/**
+ * Resource
+ */
+internal interface IResource {
+    /**
+     * Name of the resource.
+     */
+    val name: String
+
+    /**
+     * Tag name of the resource.
+     */
+    val tag: String
+}

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

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

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

@@ -0,0 +1,31 @@
+package app.revanced.patches.shared.settings.impl
+
+import app.revanced.patches.shared.settings.BaseResource
+import app.revanced.patches.shared.settings.IResource
+import org.w3c.dom.Document
+import org.w3c.dom.Element
+
+/**
+ *  Represents an array resource.
+ *
+ *  @param name The name of the array resource.
+ *  @param items The items of the array resource.
+ */
+internal data class ArrayResource(
+    override val name: String,
+    val items: List<StringResource>
+) : BaseResource(name) {
+    override val tag = "string-array"
+
+    override fun serialize(ownerDocument: Document, resourceCallback: ((IResource) -> Unit)?): Element {
+        return super.serialize(ownerDocument, resourceCallback).apply {
+            items.forEach { item ->
+                setAttribute("name", item.also { resourceCallback?.invoke(it) }.name)
+
+                this.appendChild(ownerDocument.createElement("item").also { itemNode ->
+                    itemNode.textContent = item.value
+                })
+            }
+        }
+    }
+}

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

@@ -0,0 +1,6 @@
+package app.revanced.patches.shared.settings.impl
+
+enum class InputType(val type: String) {
+    STRING("text"),
+    NUMBER("number"),
+}

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

@@ -0,0 +1,38 @@
+package app.revanced.patches.shared.settings.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 org.w3c.dom.Document
+import org.w3c.dom.Element
+
+/**
+ * List preference.
+ *
+ * @param key The key of the list preference.
+ * @param title The title of the list preference.
+ * @param entries The human-readable entries of the list preference.
+ * @param entryValues The entry values of the list preference.
+ * @param default The default entry value of the list preference.
+ * @param summary The summary of the list preference.
+ */
+internal class ListPreference(
+    key: String,
+    title: StringResource,
+    val entries: ArrayResource,
+    val entryValues: ArrayResource,
+    val default: String? = null,
+    val summary: StringResource? = null
+) : BasePreference(key, title) {
+    override val tag: String = "ListPreference"
+
+    override fun serialize(ownerDocument: Document, resourceCallback: ((IResource) -> Unit)?): Element {
+        return super.serialize(ownerDocument, resourceCallback).apply {
+            setAttribute("android:entries", "@array/${entries.also { resourceCallback?.invoke(it) }.name}")
+            setAttribute("android:entryValues", "@array/${entryValues.also { resourceCallback?.invoke(it) }.name}")
+            addDefault(default)
+            addSummary(summary)
+        }
+    }
+}

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

@@ -0,0 +1,44 @@
+package app.revanced.patches.shared.settings.impl
+
+import app.revanced.patches.shared.settings.BasePreference
+import app.revanced.patches.shared.settings.IResource
+import app.revanced.patches.shared.settings.addSummary
+import org.w3c.dom.Document
+import org.w3c.dom.Element
+
+/**
+ * A Preference object.
+ *
+ * @param title The title of the preference.
+ * @param intent The intent of the preference.
+ * @param summary The summary of the text preference.
+ */
+internal class Preference(
+    key: String,
+    title: StringResource,
+    val intent: Intent,
+    val summary: StringResource? = null
+) : BasePreference(key, title) {
+    override val tag: String = "Preference"
+
+    /* Key-less constructor */
+    constructor(
+        title: StringResource,
+        intent: Intent,
+        summary: StringResource? = null
+    ) : this("", title, intent, summary)
+
+    override fun serialize(ownerDocument: Document, resourceCallback: ((IResource) -> Unit)?): Element {
+        return super.serialize(ownerDocument, resourceCallback).apply {
+            addSummary(summary?.also { resourceCallback?.invoke(it) })
+
+            this.appendChild(ownerDocument.createElement("intent").also { intentNode ->
+                intentNode.setAttribute("android:targetPackage", intent.targetPackage)
+                intentNode.setAttribute("android:data", intent.data)
+                intentNode.setAttribute("android:targetClass", intent.targetClass)
+            })
+        }
+    }
+
+    data class Intent(val targetPackage: String, val data: String, val targetClass: String)
+}

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

@@ -0,0 +1,29 @@
+package app.revanced.patches.shared.settings.impl
+
+import app.revanced.patches.shared.settings.BasePreference
+import app.revanced.patches.shared.settings.IResource
+import org.w3c.dom.Document
+import org.w3c.dom.Element
+
+/**
+ * Preference category.
+ *
+ * @param key The key of the preference.
+ * @param title The title of the preference.
+ * @param preferences Child preferences of this category.
+ */
+internal open class PreferenceCategory(
+    key: String,
+    title: StringResource,
+    val preferences: List<BasePreference>
+) : BasePreference(key, title) {
+    override val tag: String = "PreferenceCategory"
+
+    override fun serialize(ownerDocument: Document, resourceCallback: ((IResource) -> Unit)?): Element {
+        return super.serialize(ownerDocument, resourceCallback).apply {
+            for (childPreference in preferences) {
+                this.appendChild(childPreference.serialize(ownerDocument, resourceCallback))
+            }
+        }
+    }
+}

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

@@ -0,0 +1,34 @@
+package app.revanced.patches.shared.settings.impl
+
+import app.revanced.patches.shared.settings.BasePreference
+import app.revanced.patches.shared.settings.IResource
+import app.revanced.patches.shared.settings.addSummary
+import org.w3c.dom.Document
+import org.w3c.dom.Element
+
+/**
+ * Preference screen.
+ *
+ * @param key The key of the preference.
+ * @param title The title of the preference.
+ * @param preferences Child preferences of this screen.
+ * @param summary The summary of the text preference.
+ */
+internal open class PreferenceScreen(
+    key: String,
+    title: StringResource,
+    val preferences: List<BasePreference>,
+    val summary: StringResource? = null
+) : BasePreference(key, title) {
+    override val tag: String = "PreferenceScreen"
+
+    override fun serialize(ownerDocument: Document, resourceCallback: ((IResource) -> Unit)?): Element {
+        return super.serialize(ownerDocument, resourceCallback).apply {
+            addSummary(summary?.also { resourceCallback?.invoke(it) })
+
+            for (childPreference in preferences) {
+                this.appendChild(childPreference.serialize(ownerDocument, resourceCallback))
+            }
+        }
+    }
+}

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

@@ -0,0 +1,31 @@
+package app.revanced.patches.shared.settings.impl
+
+import app.revanced.patches.shared.settings.BaseResource
+import app.revanced.patches.shared.settings.IResource
+import org.w3c.dom.Document
+import org.w3c.dom.Element
+
+/**
+ * Represents a string value in the strings.xml file
+ *
+ * @param name The name of the string
+ * @param value The value of the string
+ * @param formatted If the string is formatted. If false, the attribute will be set
+ */
+internal data class StringResource(
+    override val name: String,
+    val value: String,
+    val formatted: Boolean = true
+) : BaseResource(name) {
+    override val tag = "string"
+
+    override fun serialize(ownerDocument: Document, resourceCallback: ((IResource) -> Unit)?): Element {
+        return super.serialize(ownerDocument, resourceCallback).apply {
+            // if the string is un-formatted, explicitly add the formatted attribute
+            if (!formatted)
+                setAttribute("formatted", "false")
+
+            textContent = value
+        }
+    }
+}

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

@@ -0,0 +1,35 @@
+package app.revanced.patches.shared.settings.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 org.w3c.dom.Document
+import org.w3c.dom.Element
+
+/**
+ * Switch preference.
+ *
+ * @param key The key of the switch.
+ * @param title The title of the switch.
+ * @param default The default value of the switch.
+ * @param summaryOn The summary to show when the preference is enabled.
+ * @param summaryOff The summary to show when the preference is disabled.
+ */
+internal class SwitchPreference(
+    key: String, title: StringResource,
+    val default: Boolean = false,
+    val summaryOn: StringResource? = null,
+    val summaryOff: StringResource? = null
+) : BasePreference(key, title) {
+    override val tag: String = "SwitchPreference"
+
+    override fun serialize(ownerDocument: Document, resourceCallback: ((IResource) -> Unit)?): Element {
+        return super.serialize(ownerDocument, resourceCallback).apply {
+            addDefault(default)
+            addSummary(summaryOn?.also { resourceCallback?.invoke(it) }, SummaryType.ON)
+            addSummary(summaryOff?.also { resourceCallback?.invoke(it) }, SummaryType.OFF)
+        }
+    }
+}

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

@@ -0,0 +1,35 @@
+package app.revanced.patches.shared.settings.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 org.w3c.dom.Document
+import org.w3c.dom.Element
+
+/**
+ * Text preference.
+ *
+ * @param key The key of the text preference.
+ * @param title The title of the text preference.
+ * @param inputType The input type of the text preference.
+ * @param default The default value of the text preference.
+ * @param summary The summary of the text preference.
+ */
+internal class TextPreference(
+    key: String,
+    title: StringResource,
+    var inputType: InputType = InputType.STRING,
+    val default: String? = null,
+    val summary: StringResource? = null
+) : BasePreference(key, title) {
+    override val tag: String = "EditTextPreference"
+
+    override fun serialize(ownerDocument: Document, resourceCallback: ((IResource) -> Unit)?): Element {
+        return super.serialize(ownerDocument, resourceCallback).apply {
+            setAttribute("android:inputType", inputType.type)
+            addDefault(default)
+            addSummary(summary?.also { resourceCallback?.invoke(it) })
+        }
+    }
+}