feat: settings patch framework (#266)

src/main/kotlin/app/revanced/patches/youtube/ad/general/bytecode/patch/GeneralBytecodeAdsPatch.kt

@@ -23,6 +23,9 @@ import app.revanced.patches.youtube.ad.general.bytecode.extensions.MethodExtensi
 import app.revanced.patches.youtube.ad.general.bytecode.utils.MethodUtils.createMutableMethod
 import app.revanced.patches.youtube.misc.integrations.patch.IntegrationsPatch
 import app.revanced.patches.youtube.misc.mapping.patch.ResourceIdMappingProviderResourcePatch
+import app.revanced.patches.youtube.misc.settings.bytecode.patch.SettingsPatch
+import app.revanced.patches.youtube.misc.settings.framework.components.impl.StringResource
+import app.revanced.patches.youtube.misc.settings.framework.components.impl.SwitchPreference
 import org.jf.dexlib2.Opcode
 import org.jf.dexlib2.builder.MutableMethodImplementation
 import org.jf.dexlib2.builder.instruction.*
@@ -38,7 +41,7 @@ import org.jf.dexlib2.iface.reference.StringReference
 import org.jf.dexlib2.immutable.reference.ImmutableMethodReference
 
 @Patch
-@DependsOn([ResourceIdMappingProviderResourcePatch::class, IntegrationsPatch::class])
+@DependsOn([ResourceIdMappingProviderResourcePatch::class, IntegrationsPatch::class, SettingsPatch::class])
 @Name("general-ads")
 @Description("Removes general ads.")
 @GeneralAdsCompatibility
@@ -68,6 +71,135 @@ class GeneralBytecodeAdsPatch : BytecodePatch() {
     )
 
     override fun execute(data: BytecodeData): PatchResult {
+        SettingsPatch.PreferenceScreen.ADS.addPreferences(
+            SwitchPreference(
+                "revanced_home_ads_enabled",
+                StringResource("revanced_home_ads_enabled_title", "Hide home ads"),
+                true,
+                StringResource("revanced_home_ads_enabled_summary_on", "Home ads are shown"),
+                StringResource("revanced_home_ads_enabled_summary_off", "Home ads are hidden")
+            ),
+            SwitchPreference(
+                "revanced_adremover_ad_removal",
+                StringResource("revanced_adremover_ad_removal_enabled_title", "Remove general ads"),
+                true,
+                StringResource("revanced_adremover_ad_removal_enabled_summary_on", "General ads are hidden"),
+                StringResource("revanced_adremover_ad_removal_enabled_summary_off", "General ads are shown")
+            ),
+            SwitchPreference(
+                "revanced_adremover_merchandise",
+                StringResource("revanced_adremover_merchandise_enabled_title", "Remove merchandise banners"),
+                true,
+                StringResource("revanced_adremover_merchandise_enabled_summary_on", "Merchandise banners are hidden"),
+                StringResource("revanced_adremover_merchandise_enabled_summary_off", "Merchandise banners are shown")
+            ),
+            SwitchPreference(
+                "revanced_adremover_community_posts_removal",
+                StringResource("revanced_adremover_community_posts_enabled_title", "Remove community posts"),
+                true,
+                StringResource("revanced_adremover_community_posts_enabled_summary_on", "Community posts are hidden"),
+                StringResource("revanced_adremover_community_posts_enabled_summary_off", "Community posts are shown")
+            ),
+            SwitchPreference(
+                "revanced_adremover_compact_banner_removal",
+                StringResource("revanced_adremover_compact_banner_enabled_title", "Remove compact banners"),
+                true,
+                StringResource("revanced_adremover_compact_banner_enabled_summary_on", "Compact banners are hidden"),
+                StringResource("revanced_adremover_compact_banner_enabled_summary_off", "Compact banners are shown")
+            ),
+            SwitchPreference(
+                "revanced_adremover_comments_removal",
+                StringResource("revanced_adremover_comments_enabled_title", "Remove comments section"),
+                false,
+                StringResource("revanced_adremover_comments_enabled_summary_on", "Comment section is hidden"),
+                StringResource("revanced_adremover_comments_enabled_summary_off", "Comment section is shown")
+            ),
+            SwitchPreference(
+                "revanced_adremover_movie",
+                StringResource("revanced_adremover_movie_enabled_title", "Remove movies section"),
+                true,
+                StringResource("revanced_adremover_movie_enabled_summary_on", "Movies section is hidden"),
+                StringResource("revanced_adremover_movie_enabled_summary_off", "Movies section is shown")
+            ),
+            SwitchPreference(
+                "revanced_adremover_feed_survey",
+                StringResource("revanced_adremover_feed_survey_enabled_title", "Remove feed surveys"),
+                true,
+                StringResource("revanced_adremover_feed_survey_enabled_summary_on", "Feed surveys are hidden"),
+                StringResource("revanced_adremover_feed_survey_enabled_summary_off", "Feed surveys are shown")
+            ),
+            SwitchPreference(
+                "revanced_adremover_shorts_shelf",
+                StringResource("revanced_adremover_shorts_shelf_enabled_title", "Remove shorts shelf"),
+                true,
+                StringResource("revanced_adremover_shorts_shelf_enabled_summary_on", "Shorts shelves are hidden"),
+                StringResource("revanced_adremover_shorts_shelf_enabled_summary_off", "Shorts shelves are shown")
+            ),
+            SwitchPreference(
+                "revanced_adremover_community_guidelines",
+                StringResource("revanced_adremover_community_guidelines_enabled_title", "Remove community guidelines"),
+                true,
+                StringResource("revanced_adremover_community_guidelines_enabled_summary_on", "Community guidelines are hidden"),
+                StringResource("revanced_adremover_community_guidelines_enabled_summary_off", "Community guidelines are shown")
+            ),
+            SwitchPreference(
+                "revanced_adremover_emergency_box_removal",
+                StringResource("revanced_adremover_emergency_box_enabled_title", "Remove emergency boxes"),
+                true,
+                StringResource("revanced_adremover_emergency_box_enabled_summary_on", "Emergency boxes are hidden"),
+                StringResource("revanced_adremover_emergency_box_enabled_summary_off", "Emergency boxes are shown")
+            ),
+            SwitchPreference(
+                "revanced_adremover_info_panel",
+                StringResource("revanced_adremover_info_panel_enabled_title", "Remove info panels"),
+                true,
+                StringResource("revanced_adremover_info_panel_enabled_summary_on", "Merchandise banners are hidden"),
+                StringResource("revanced_adremover_info_panel_enabled_summary_off", "Merchandise banners are shown")
+            ),
+            SwitchPreference(
+                "revanced_adremover_medical_panel",
+                StringResource("revanced_adremover_medical_panel_enabled_title", "Remove medical panels"),
+                true,
+                StringResource("revanced_adremover_medical_panel_enabled_summary_on", "Medical panels are hidden"),
+                StringResource("revanced_adremover_medical_panel_enabled_summary_off", "Medical panels are shown")
+            ),
+            SwitchPreference(
+                "revanced_adremover_paid_content",
+                StringResource("revanced_adremover_paid_content_enabled_title", "Remove paid content"),
+                true,
+                StringResource("revanced_adremover_paid_content_enabled_summary_on", "Paid content is hidden"),
+                StringResource("revanced_adremover_paid_content_enabled_summary_off", "Paid content is shown")
+            ),
+            SwitchPreference(
+                "revanced_adremover_suggested",
+                StringResource("revanced_adremover_suggested_enabled_title", "Remove personal suggestions"),
+                true,
+                StringResource("revanced_adremover_suggested_enabled_summary_on", "Personal suggestions are hidden"),
+                StringResource("revanced_adremover_suggested_enabled_summary_off", "Personal suggestions are shown")
+            ),
+            SwitchPreference(
+                "revanced_adremover_hide_suggestions",
+                StringResource("revanced_adremover_hide_suggestions_enabled_title", "Hide suggestions"),
+                true,
+                StringResource("revanced_adremover_hide_suggestions_enabled_summary_on", "Suggestions are hidden"),
+                StringResource("revanced_adremover_hide_suggestions_enabled_summary_off", "Suggestions are shown")
+            ),
+            SwitchPreference(
+                "revanced_adremover_hide_latest_posts",
+                StringResource("revanced_adremover_hide_latest_posts_enabled_title", "Hide latest posts"),
+                true,
+                StringResource("revanced_adremover_hide_latest_posts_enabled_summary_on", "Latest posts are hidden"),
+                StringResource("revanced_adremover_hide_latest_posts_enabled_summary_off", "Latest posts are shown")
+            ),
+            SwitchPreference(
+                "revanced_adremover_hide_channel_guidelines",
+                StringResource("revanced_adremover_hide_channel_guidelines_enabled_title", "Hide channel guidelines"),
+                true,
+                StringResource("revanced_adremover_hide_channel_guidelines_enabled_summary_on", "Channel guidelines are hidden"),
+                StringResource("revanced_adremover_hide_channel_guidelines_enabled_summary_off", "Channel guidelines are shown")
+            ),
+        )
+
         // iterating through all classes is expensive
         for (classDef in data.classes) {
             var mutableClass: MutableClass? = null

src/main/kotlin/app/revanced/patches/youtube/ad/infocardsuggestions/patch/HideInfocardSuggestionsPatch.kt

@@ -16,10 +16,13 @@ import app.revanced.patches.youtube.ad.infocardsuggestions.annotations.HideInfoc
 import app.revanced.patches.youtube.ad.infocardsuggestions.fingerprints.HideInfocardSuggestionsFingerprint
 import app.revanced.patches.youtube.ad.infocardsuggestions.fingerprints.HideInfocardSuggestionsParentFingerprint
 import app.revanced.patches.youtube.misc.integrations.patch.IntegrationsPatch
+import app.revanced.patches.youtube.misc.settings.bytecode.patch.SettingsPatch
+import app.revanced.patches.youtube.misc.settings.framework.components.impl.StringResource
+import app.revanced.patches.youtube.misc.settings.framework.components.impl.SwitchPreference
 import org.jf.dexlib2.builder.instruction.BuilderInstruction35c
 
 @Patch
-@DependsOn([IntegrationsPatch::class])
+@DependsOn([IntegrationsPatch::class, SettingsPatch::class])
 @Name("hide-infocard-suggestions")
 @Description("Hides infocards in videos.")
 @HideInfocardSuggestionsCompatibility
@@ -30,6 +33,16 @@ class HideInfocardSuggestionsPatch : BytecodePatch(
     )
 ) {
     override fun execute(data: BytecodeData): PatchResult {
+        SettingsPatch.PreferenceScreen.ADS.addPreferences(
+            SwitchPreference(
+                "revanced_info_cards_enabled",
+                StringResource("revanced_info_cards_enabled_title", "Show info-cards"),
+                false,
+                StringResource("revanced_info_cards_enabled_summary_on", "Info-cards are shown"),
+                StringResource("revanced_info_cards_enabled_summary_off", "Info-cards are hidden")
+            )
+        )
+
         val parentResult = HideInfocardSuggestionsParentFingerprint.result
             ?: return PatchResultError("Parent fingerprint not resolved!")
 

src/main/kotlin/app/revanced/patches/youtube/ad/video/patch/VideoAdsPatch.kt

@@ -15,9 +15,12 @@ import app.revanced.patches.youtube.ad.video.annotations.VideoAdsCompatibility
 import app.revanced.patches.youtube.ad.video.fingerprints.ShowVideoAdsConstructorFingerprint
 import app.revanced.patches.youtube.ad.video.fingerprints.ShowVideoAdsFingerprint
 import app.revanced.patches.youtube.misc.integrations.patch.IntegrationsPatch
+import app.revanced.patches.youtube.misc.settings.bytecode.patch.SettingsPatch
+import app.revanced.patches.youtube.misc.settings.framework.components.impl.StringResource
+import app.revanced.patches.youtube.misc.settings.framework.components.impl.SwitchPreference
 
 @Patch
-@DependsOn([IntegrationsPatch::class])
+@DependsOn([IntegrationsPatch::class, SettingsPatch::class])
 @Name("video-ads")
 @Description("Removes ads in the video player.")
 @VideoAdsCompatibility
@@ -28,7 +31,19 @@ class VideoAdsPatch : BytecodePatch(
     )
 ) {
     override fun execute(data: BytecodeData): PatchResult {
-        ShowVideoAdsFingerprint.resolve(data, ShowVideoAdsConstructorFingerprint.result!!.classDef)
+        SettingsPatch.PreferenceScreen.ADS.addPreferences(
+            SwitchPreference(
+                "revanced_video_ads_enabled",
+                StringResource("revanced_video_ads_enabled_title", "Hide video ads"),
+                true,
+                StringResource("revanced_video_ads_enabled_summary_on", "Video ads are hidden"),
+                StringResource("revanced_video_ads_enabled_summary_off", "Video ads are shown")
+            )
+        )
+
+        ShowVideoAdsFingerprint.resolve(
+            data, ShowVideoAdsConstructorFingerprint.result!!.classDef
+        )
 
         // Override the parameter by calling shouldShowAds and setting the parameter to the result
         ShowVideoAdsFingerprint.result!!.mutableMethod.addInstructions(
@@ -40,4 +55,4 @@ class VideoAdsPatch : BytecodePatch(
 
         return PatchResultSuccess()
     }
-}
+}

src/main/kotlin/app/revanced/patches/youtube/interaction/seekbar/patch/EnableSeekbarTappingPatch.kt

@@ -15,14 +15,17 @@ import app.revanced.patches.youtube.interaction.seekbar.annotation.SeekbarTappin
 import app.revanced.patches.youtube.interaction.seekbar.fingerprints.SeekbarTappingFingerprint
 import app.revanced.patches.youtube.interaction.seekbar.fingerprints.SeekbarTappingParentFingerprint
 import app.revanced.patches.youtube.misc.integrations.patch.IntegrationsPatch
+import app.revanced.patches.youtube.misc.settings.bytecode.patch.SettingsPatch
+import app.revanced.patches.youtube.misc.settings.framework.components.impl.StringResource
+import app.revanced.patches.youtube.misc.settings.framework.components.impl.SwitchPreference
 import org.jf.dexlib2.Opcode
 import org.jf.dexlib2.builder.instruction.BuilderInstruction21t
 import org.jf.dexlib2.iface.Method
 import org.jf.dexlib2.iface.instruction.formats.Instruction11n
 import org.jf.dexlib2.iface.instruction.formats.Instruction35c
 
 @Patch
-@DependsOn([IntegrationsPatch::class])
+@DependsOn([IntegrationsPatch::class, SettingsPatch::class])
 @Name("seekbar-tapping")
 @Description("Enables tap-to-seek on the seekbar of the video player.")
 @SeekbarTappingCompatibility
@@ -33,6 +36,16 @@ class EnableSeekbarTappingPatch : BytecodePatch(
     )
 ) {
     override fun execute(data: BytecodeData): PatchResult {
+        SettingsPatch.PreferenceScreen.INTERACTIONS.addPreferences(
+            SwitchPreference(
+                "revanced_enable_tap_seeking",
+                StringResource("revanced_seekbar_tapping_enabled_title", "Enable seekbar tapping"),
+                true,
+                StringResource("revanced_seekbar_tapping_summary_on", "Seekbar tapping is enabled"),
+                StringResource("revanced_seekbar_tapping_summary_off", "Seekbar tapping is disabled")
+            )
+        )
+
         var result = SeekbarTappingParentFingerprint.result!!
 
         val tapSeekMethods = mutableMapOf<String, Method>()
@@ -42,7 +55,7 @@ class EnableSeekbarTappingPatch : BytecodePatch(
             if (it.implementation == null) continue
 
             val instructions = it.implementation!!.instructions
-            // here we make sure we actually find the method because it has more then 7 instructions
+            // here we make sure we actually find the method because it has more than 7 instructions
             if (instructions.count() < 7) continue
 
             // we know that the 7th instruction has the opcode CONST_4

src/main/kotlin/app/revanced/patches/youtube/interaction/swipecontrols/patch/bytecode/SwipeControlsBytecodePatch.kt

@@ -65,5 +65,4 @@ class SwipeControlsBytecodePatch : BytecodePatch(
         }
         return PatchResultSuccess()
     }
-}
-
+}