feat(YouTube - Hide layout components): Filter home/search results by keywords

[LisoUseInAIKyrios]

Allows hiding videos from the feed/search based on keywords.

Keywords can be any text that appears in video titles, or the channel title of a YouTube creator.

This patch is not a replacement for hiding individual channels in the home feed, because that can already be done in YouTube (tap three dots on a video, then "Don't recommend channel"). This patch is to hide topics from the home feed and search, and to hide videos from specific channels from the search results.

Spacing and punctuation is important for keywords. If you want to hide Mr Beast from your search, then you need to add both Mr Beast (name used in video titles) and MrBeast (his channel name).

Screenshots

Search results unfiltered

Search results with keyword filters 'MrBeast' and 'Mr Beast'

Limitations

Shorts can still show up in the search results

If using a channel name as a keyword filter, then most Shorts from that channel will still show up in search results. This is because Shorts do not show the channel name, so the filter will not catch them.

Some UI layout residue will remain

Some extra UI components around a search result may not be hidden, such as the video chapter preview that appears below some search results.

Case sensitive keywords

Keywords are case sensitive, so if you use a filter of Mr Beast it will not filter any videos with titles that contain odd casing such as mr BEAst. This patch automatically includes common case variations, and entering Mr Beast automatically filters mr beast and MR BEAST. But if a keyword has unusual casing then you must enter the exact casing (ie: LeBlanc, TikTok).

Searching for a keyword phrase can show no search results

This is because the protobuffer for each search result includes your search text. So if you keyword filter Mr Beast and then search for Mr Beast, the patch will hide every search result. If you still want to search for a specific phrase you can get around this by searching for the same phrase but with odd casing -- ie: search for mr BEAst.

In a similar limitation, certain words cannot be used as filters and adding any of them will always hide all videos. These words includes google, youtube, video, android, avatar, and any other buffer text found in every video. This is because these words are used for layout components or are found in video data (such as googlevideo.com/initplayback used to start video playback). This patch checks for many of these restricted words, but it is not an exhaustive check and some keywords can still hide everything.

[LisoUseInAIKyrios]

Closes
#1393
#1104

[LisoUseInAIKyrios]

I initially thought performance might be an issue, but it appears performance is just fine.

Searching the protobuffer for each search result takes less than 1ms, which is too insignificant to make any difference.

[MarcaDian]

Hello. Why i cant filter this channel from search?
I see that the channel avatar just disappeared in the search results, but not the video.
the filter only works by keywords, but I can't filter specifically by the channel link.

[LisoUseInAIKyrios]

Hello. Why i cant filter this channel from search?

Because you need to use the channel title name, and not the @ name.

[LisoUseInAIKyrios]

Unicode is now supported in both keyword and custom filters.

I realized the byte array comparison is unaffected by unicode hurdles such as surrogate or combining characters. It's just a plain byte to byte comparison and it does not care or is affected by these issues.

[MarcaDian]

can you add sorting = Sorting.UNSORTED, ? same issue like color seekbar

Edit: At first glance, everything works, in Unicode

[Leenkss]

Hi, can you add buttons for automatic hide videos or channels name from searching ?
Pic from pc

[LisoUseInAIKyrios]

can you add buttons for automatic hide videos or channels name from searching?

A flyout menu item to hide a chanel would be useful.

But as far as I know, adding layout items to litho has not yet been done by any patch. Someone would need to figure out how to add content to an existing layout and add a callback when the item is tapped.

[oSumAtrIX]

It looks like, at least for short carousels, if a keyword is matched the entire carousel is blocked (example "beast"):

[LisoUseInAIKyrios]

It looks like, at least for short carousels, if a keyword is matched the entire carousel is blocked

What is the full path for the carousel? Maybe the individual videos in the carousel can be filtered instead of the entire parent component.

Edit: the full path is shorts_shelf.eml|123|CellType|shorts_shelf_carousel.eml|123|CollectionType|shorts_lockup_cell.eml
and it it now filters out the individual Shorts from the carousel.

[LisoUseInAIKyrios]

It looks like, at least for short carousels, if a keyword is matched the entire carousel is blocked (example "beast").

The carousel and Shorts shelf as a whole are not hidden if any of the enclosed Short are filtered. In that screenshot I think the entire group of Shorts was filtered away because every short had a title that matched a keyword.

The carousel Shorts path is the same for both search and the subscription feed, and this means it filters carousel Shorts in both search and the subscription tab (which may or may not be what the user wants).

I think the ideal fix is to add hooks to figure out what navigation tab is active, and then add setting switches to filter home/subscription/search items. The same hooks would also be useful for Alternatively thumbnails to do the same (apply only to home/subscriptions/search).

[oSumAtrIX]

I think the entire group of Shorts was filtered away because every short had a title that matched a keyword.

To note, in the screenshot I added, the title of the first Short did not match the keyword, but likely the buffer string contained it. Nothing that can be done here though.

[MarcaDian]

After last commit. Also force pushed from filter_keyword_content branch to my, same error 🙃
Edit: this error maybe apear after 0de51bf

ReVanced Manager: 1.19.4-dev.2
Model: M2004J19C
Android version: 12
Supported architectures: arm64-v8a, armeabi-v7a, armeabi
Root permissions: No

- Patch Info
App: com.google.android.youtube v19.09.38 (Suggested: 19.08.36)
Patches version: test8
Patches added: Default
Patches removed: Announcements, Enable debugging
Default patch options changed: None

- Settings
Allow changing patch selection: true
Version compatibility check: false
Show universal patches: false
Patches source: MarcaDian/revanced-patches-old
Integration source: MarcaDian/revanced-integrations-old

- Logs
Reading APK
Decoding app manifest
Loading patches
Merging integrations
Deleting existing temporary files directory
Decoding resources
Executing patches
Applied 59 patches
Hide layout components failed: app.revanced.patcher.patch.PatchException: 'Hide layout components' depends on 'NavigationBarHookPatch' that raised an exception:
app.revanced.patcher.patch.PatchException: Failed to resolve NavigationBarHookCallbackFingerprint
	at app.revanced.util.BytecodeUtilsKt.getException(BytecodeUtils.kt:27)
	at app.revanced.util.BytecodeUtilsKt.resultOrThrow(BytecodeUtils.kt:19)
	at app.revanced.patches.youtube.misc.navigation.NavigationBarHookPatch.execute(NavigationBarHookPatch.kt:98)
	at app.revanced.patches.youtube.misc.navigation.NavigationBarHookPatch.execute(NavigationBarHookPatch.kt:25)
	at app.revanced.patcher.Patcher$apply$1.invokeSuspend$executePatch(Unknown Source:190)
	at app.revanced.patcher.Patcher$apply$1.invokeSuspend$executePatch(Unknown Source:91)
	at app.revanced.patcher.Patcher$apply$1.invokeSuspend(Unknown Source:292)
	at app.revanced.patcher.Patcher$apply$1.invoke(SourceFile:1)
	at app.revanced.patcher.Patcher$apply$1.invoke(SourceFile:2)
	at b6.f.b(Unknown Source:2)
	at b6.a.a(Unknown Source:71)
	at app.revanced.manager.flutter.MainActivity$runPatcher$1$patcherResult$1$2.invokeSuspend(Unknown Source:76)
	at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(Unknown Source:11)
	at y5.o0.run(Unknown Source:93)
	at y5.u0.P(Unknown Source:46)
	at y5.e.t0(Unknown Source:23)
	at y5.h.a(Unknown Source:73)
	at y5.g.c(Unknown Source:0)
	at y5.h.b(Unknown Source:6)
	at y5.g.d(Unknown Source:0)
	at app.revanced.manager.flutter.MainActivity.runPatcher$lambda$34(Unknown Source:470)
	at app.revanced.manager.flutter.MainActivity.k(Unknown Source:0)
	at app.revanced.manager.flutter.f.run(Unknown Source:20)
	at java.lang.Thread.run(Thread.java:920)

	at app.revanced.patcher.Patcher$apply$1.invokeSuspend$executePatch(Unknown Source:148)
	at app.revanced.patcher.Patcher$apply$1.invokeSuspend(Unknown Source:292)
	at app.revanced.patcher.Patcher$apply$1.invoke(SourceFile:1)
	at app.revanced.patcher.Patcher$apply$1.invoke(SourceFile:2)
	at b6.f.b(Unknown Source:2)
	at b6.a.a(Unknown Source:71)
	at app.revanced.manager.flutter.MainActivity$runPatcher$1$patcherResult$1$2.invokeSuspend(Unknown Source:76)
	at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(Unknown Source:11)
	at y5.o0.run(Unknown Source:93)
	at y5.u0.P(Unknown Source:46)
	at y5.e.t0(Unknown Source:23)
	at y5.h.a(Unknown Source:73)
	at y5.g.c(Unknown Source:0)
	at y5.h.b(Unknown Source:6)
	at y5.g.d(Unknown Source:0)
	at app.revanced.manager.flutter.MainActivity.runPatcher$lambda$34(Unknown Source:470)
	at app.revanced.manager.flutter.MainActivity.k(Unknown Source:0)
	at app.revanced.manager.flutter.f.run(Unknown Source:20)
	at java.lang.Thread.run(Thread.java:920)
Navigation buttons failed: app.revanced.patcher.patch.PatchException: 'Navigation buttons' depends on 'NavigationBarHookPatch' that raised an exception:
app.revanced.patcher.patch.PatchException: 'NavigationBarHookPatch' did not succeed previously
	at app.revanced.patcher.Patcher$apply$1.invokeSuspend$executePatch(Unknown Source:45)
	at app.revanced.patcher.Patcher$apply$1.invokeSuspend$executePatch(Unknown Source:91)
	at app.revanced.patcher.Patcher$apply$1.invokeSuspend(Unknown Source:292)
	at app.revanced.patcher.Patcher$apply$1.invoke(SourceFile:1)
	at app.revanced.patcher.Patcher$apply$1.invoke(SourceFile:2)
	at b6.f.b(Unknown Source:2)
	at b6.a.a(Unknown Source:71)
	at app.revanced.manager.flutter.MainActivity$runPatcher$1$patcherResult$1$2.invokeSuspend(Unknown Source:76)
	at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(Unknown Source:11)
	at y5.o0.run(Unknown Source:93)
	at y5.u0.P(Unknown Source:46)
	at y5.e.t0(Unknown Source:23)
	at y5.h.a(Unknown Source:73)
	at y5.g.c(Unknown Source:0)
	at y5.h.b(Unknown Source:6)
	at y5.g.d(Unknown Source:0)
	at app.revanced.manager.flutter.MainActivity.runPatcher$lambda$34(Unknown Source:470)
	at app.revanced.manager.flutter.MainActivity.k(Unknown Source:0)
	at app.revanced.manager.flutter.f.run(Unknown Source:20)
	at java.lang.Thread.run(Thread.java:920)

	at app.revanced.patcher.Patcher$apply$1.invokeSuspend$executePatch(Unknown Source:148)
	at app.revanced.patcher.Patcher$apply$1.invokeSuspend(Unknown Source:292)
	at app.revanced.patcher.Patcher$apply$1.invoke(SourceFile:1)
	at app.revanced.patcher.Patcher$apply$1.invoke(SourceFile:2)
	at b6.f.b(Unknown Source:2)
	at b6.a.a(Unknown Source:71)
	at app.revanced.manager.flutter.MainActivity$runPatcher$1$patcherResult$1$2.invokeSuspend(Unknown Source:76)
	at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(Unknown Source:11)
	at y5.o0.run(Unknown Source:93)
	at y5.u0.P(Unknown Source:46)
	at y5.e.t0(Unknown Source:23)
	at y5.h.a(Unknown Source:73)
	at y5.g.c(Unknown Source:0)
	at y5.h.b(Unknown Source:6)
	at y5.g.d(Unknown Source:0)
	at app.revanced.manager.flutter.MainActivity.runPatcher$lambda$34(Unknown Source:470)
	at app.revanced.manager.flutter.MainActivity.k(Unknown Source:0)
	at app.revanced.manager.flutter.f.run(Unknown Source:20)
	at java.lang.Thread.run(Thread.java:920)
Compiling patched dex files
Compiled 8 dex files
Compiling modified resources
Aligning APK
Signing APK
Patched APK

[oSumAtrIX]

Nothing that can cause your exception has been changed

[LisoUseInAIKyrios]

After last commit. Also force pushed from filter_keyword_content branch to my, same error

It is patching correctly for me. The failing fingerprint is for an Integrations method.

Verify you are building with the integrations branch for this PR.