fix(YouTube/Shorts components): even if Hide navigation bar is turned on, the navigation bar will reappear when the user opens the comments or description panel in Shorts

This commit is contained in:
inotia00 2024-09-25 22:23:54 +09:00
parent 6c060c5da6
commit 2cdc05ac27
10 changed files with 301 additions and 84 deletions

View File

@ -1,71 +1,83 @@
package app.revanced.patches.youtube.shorts.components
import app.revanced.patcher.data.BytecodeContext
import app.revanced.patcher.extensions.InstructionExtensions.addInstruction
import app.revanced.patcher.extensions.InstructionExtensions.addInstructions
import app.revanced.patcher.extensions.InstructionExtensions.getInstruction
import app.revanced.patcher.patch.BytecodePatch
import app.revanced.patches.youtube.shorts.components.fingerprints.BottomNavigationBarFingerprint
import app.revanced.patches.youtube.shorts.components.fingerprints.RenderBottomNavigationBarFingerprint
import app.revanced.patches.youtube.shorts.components.fingerprints.SetPivotBarFingerprint
import app.revanced.patcher.patch.annotation.Patch
import app.revanced.patches.youtube.shorts.components.fingerprints.BottomBarContainerHeightFingerprint
import app.revanced.patches.youtube.shorts.components.fingerprints.ReelWatchPagerFingerprint
import app.revanced.patches.youtube.utils.integrations.Constants.SHORTS_CLASS_DESCRIPTOR
import app.revanced.patches.youtube.utils.navigation.fingerprints.InitializeButtonsFingerprint
import app.revanced.patches.youtube.utils.navigation.NavigationBarHookPatch
import app.revanced.patches.youtube.utils.resourceid.SharedResourceIdPatch.BottomBarContainer
import app.revanced.patches.youtube.utils.resourceid.SharedResourceIdPatch.ReelWatchPlayer
import app.revanced.util.REGISTER_TEMPLATE_REPLACEMENT
import app.revanced.util.fingerprint.MultiMethodFingerprint
import app.revanced.util.getReference
import app.revanced.util.getWalkerMethod
import app.revanced.util.indexOfFirstInstructionOrThrow
import app.revanced.util.indexOfFirstWideLiteralInstructionValue
import app.revanced.util.injectLiteralInstructionViewCall
import app.revanced.util.patch.MultiMethodBytecodePatch
import app.revanced.util.resultOrThrow
import com.android.tools.smali.dexlib2.iface.instruction.OneRegisterInstruction
import com.android.tools.smali.dexlib2.iface.reference.MethodReference
object ShortsNavigationBarPatch : BytecodePatch(
setOf(
BottomNavigationBarFingerprint,
InitializeButtonsFingerprint,
RenderBottomNavigationBarFingerprint
)
/**
* Up to YouTube 19.28.42, there are two Methods with almost the same pattern.
*
* In certain YouTube versions, the hook should be done not on the first matching Method, but also on the last matching Method.
*
* 'Multiple fingerprint search' feature is not yet implemented in ReVanced Patcher,
* So I just implement it via [MultiMethodFingerprint].
*
* Related Issues:
* https://github.com/ReVanced/revanced-patcher/issues/74
* https://github.com/ReVanced/revanced-patcher/issues/308
*/
@Patch(dependencies = [NavigationBarHookPatch::class])
object ShortsNavigationBarPatch : MultiMethodBytecodePatch(
fingerprints = setOf(ReelWatchPagerFingerprint),
multiFingerprints = setOf(BottomBarContainerHeightFingerprint)
) {
override fun execute(context: BytecodeContext) {
super.execute(context)
InitializeButtonsFingerprint.resultOrThrow().let { parentResult ->
SetPivotBarFingerprint.also { it.resolve(context, parentResult.classDef) }
.resultOrThrow().let {
it.mutableMethod.apply {
val startIndex = it.scanResult.patternScanResult!!.startIndex
val register = getInstruction<OneRegisterInstruction>(startIndex).registerA
// region patch for set navigation bar height.
addInstruction(
startIndex + 1,
"invoke-static {v$register}, $SHORTS_CLASS_DESCRIPTOR->setNavigationBar(Ljava/lang/Object;)V"
)
}
}
}
RenderBottomNavigationBarFingerprint.resultOrThrow().let {
val walkerMethod =
it.getWalkerMethod(context, it.scanResult.patternScanResult!!.endIndex)
walkerMethod.addInstruction(
0,
"invoke-static {}, $SHORTS_CLASS_DESCRIPTOR->hideShortsNavigationBar()V"
)
}
BottomNavigationBarFingerprint.result?.let {
BottomBarContainerHeightFingerprint.resultOrThrow().forEach {
it.mutableMethod.apply {
val targetIndex = indexOfFirstInstructionOrThrow {
getReference<MethodReference>()?.name == "findViewById"
val constIndex = indexOfFirstWideLiteralInstructionValue(BottomBarContainer)
val targetIndex = indexOfFirstInstructionOrThrow(constIndex) {
getReference<MethodReference>()?.name == "getHeight"
} + 1
val insertRegister = getInstruction<OneRegisterInstruction>(targetIndex).registerA
val heightRegister = getInstruction<OneRegisterInstruction>(targetIndex).registerA
addInstructions(
targetIndex + 1, """
invoke-static {v$insertRegister}, $SHORTS_CLASS_DESCRIPTOR->hideShortsNavigationBar(Landroid/view/View;)Landroid/view/View;
move-result-object v$insertRegister
invoke-static {v$heightRegister}, $SHORTS_CLASS_DESCRIPTOR->overrideNavigationBarHeight(I)I
move-result v$heightRegister
"""
)
}
}
NavigationBarHookPatch.addBottomBarContainerHook("$SHORTS_CLASS_DESCRIPTOR->setNavigationBar(Landroid/view/View;)V")
// endregion.
// region patch for addOnAttachStateChangeListener.
val smaliInstruction = """
invoke-static {v$REGISTER_TEMPLATE_REPLACEMENT}, $SHORTS_CLASS_DESCRIPTOR->onShortsCreate(Landroid/view/View;)V
"""
ReelWatchPagerFingerprint.injectLiteralInstructionViewCall(
ReelWatchPlayer,
smaliInstruction
)
// endregion.
}
}

View File

@ -0,0 +1,17 @@
package app.revanced.patches.youtube.shorts.components.fingerprints
import app.revanced.patcher.extensions.or
import app.revanced.patches.youtube.utils.resourceid.SharedResourceIdPatch.BottomBarContainer
import app.revanced.util.containsWideLiteralInstructionValue
import app.revanced.util.fingerprint.MultiMethodFingerprint
import com.android.tools.smali.dexlib2.AccessFlags
internal object BottomBarContainerHeightFingerprint : MultiMethodFingerprint(
returnType = "V",
accessFlags = AccessFlags.PUBLIC or AccessFlags.FINAL,
parameters = listOf("Landroid/view/View;", "Landroid/os/Bundle;"),
strings = listOf("r_pfvc"),
customFingerprint = { methodDef, _ ->
methodDef.containsWideLiteralInstructionValue(BottomBarContainer)
},
)

View File

@ -1,12 +0,0 @@
package app.revanced.patches.youtube.shorts.components.fingerprints
import app.revanced.patcher.extensions.or
import app.revanced.patcher.fingerprint.MethodFingerprint
import com.android.tools.smali.dexlib2.AccessFlags
internal object BottomNavigationBarFingerprint : MethodFingerprint(
returnType = "V",
accessFlags = AccessFlags.PUBLIC or AccessFlags.FINAL,
parameters = listOf("Landroid/view/View;", "Landroid/os/Bundle;"),
strings = listOf("r_pfvc", "ReelWatchPaneFragmentViewModelKey")
)

View File

@ -0,0 +1,12 @@
package app.revanced.patches.youtube.shorts.components.fingerprints
import app.revanced.patcher.extensions.or
import app.revanced.patches.youtube.utils.resourceid.SharedResourceIdPatch.ReelWatchPlayer
import app.revanced.util.fingerprint.LiteralValueFingerprint
import com.android.tools.smali.dexlib2.AccessFlags
internal object ReelWatchPagerFingerprint : LiteralValueFingerprint(
accessFlags = AccessFlags.PUBLIC or AccessFlags.FINAL,
returnType = "Landroid/view/View;",
literalSupplier = { ReelWatchPlayer }
)

View File

@ -1,13 +0,0 @@
package app.revanced.patches.youtube.shorts.components.fingerprints
import app.revanced.patcher.fingerprint.MethodFingerprint
import com.android.tools.smali.dexlib2.Opcode
internal object RenderBottomNavigationBarFingerprint : MethodFingerprint(
returnType = "Landroid/view/View;",
opcodes = listOf(
Opcode.CONST_STRING,
Opcode.INVOKE_VIRTUAL
),
strings = listOf("r_pfcv")
)

View File

@ -1,16 +0,0 @@
package app.revanced.patches.youtube.shorts.components.fingerprints
import app.revanced.patcher.extensions.or
import app.revanced.patcher.fingerprint.MethodFingerprint
import com.android.tools.smali.dexlib2.AccessFlags
import com.android.tools.smali.dexlib2.Opcode
internal object SetPivotBarFingerprint : MethodFingerprint(
returnType = "V",
accessFlags = AccessFlags.PRIVATE or AccessFlags.FINAL,
parameters = listOf("Z"),
opcodes = listOf(
Opcode.CHECK_CAST,
Opcode.IF_EQZ
)
)

View File

@ -95,6 +95,7 @@ object SharedResourceIdPatch : ResourcePatch() {
var ReelRightLikeIcon = -1L
var ReelTimeBarPlayedColor = -1L
var ReelVodTimeStampsContainer = -1L
var ReelWatchPlayer = -1L
var RelatedChipCloudMargin = -1L
var RightComment = -1L
var ScrimOverlay = -1L
@ -204,6 +205,7 @@ object SharedResourceIdPatch : ResourcePatch() {
ReelRightLikeIcon = getId(DRAWABLE, "reel_right_like_icon")
ReelTimeBarPlayedColor = getId(COLOR, "reel_time_bar_played_color")
ReelVodTimeStampsContainer = getId(ID, "reel_vod_timestamps_container")
ReelWatchPlayer = getId(ID, "reel_watch_player")
RelatedChipCloudMargin = getId(LAYOUT, "related_chip_cloud_reduced_margins")
RightComment = getId(DRAWABLE, "ic_right_comment_32c")
ScrimOverlay = getId(ID, "scrim_overlay")

View File

@ -16,6 +16,7 @@ import app.revanced.patcher.util.proxy.mutableTypes.MutableClass
import app.revanced.patcher.util.proxy.mutableTypes.MutableField
import app.revanced.patcher.util.proxy.mutableTypes.MutableField.Companion.toMutable
import app.revanced.patcher.util.proxy.mutableTypes.MutableMethod
import app.revanced.util.fingerprint.MultiMethodFingerprint
import com.android.tools.smali.dexlib2.AccessFlags
import com.android.tools.smali.dexlib2.Opcode
import com.android.tools.smali.dexlib2.iface.Method
@ -38,6 +39,8 @@ fun MethodFingerprint.isDeprecated() =
fun MethodFingerprint.resultOrThrow() = result ?: throw exception
fun MultiMethodFingerprint.resultOrThrow() = result.ifEmpty { throw exception }
/**
* The [PatchException] of failing to resolve a [MethodFingerprint].
*
@ -46,6 +49,9 @@ fun MethodFingerprint.resultOrThrow() = result ?: throw exception
val MethodFingerprint.exception
get() = PatchException("Failed to resolve ${this.javaClass.simpleName}")
val MultiMethodFingerprint.exception
get() = PatchException("Failed to resolve ${this.javaClass.simpleName}")
fun MethodFingerprint.alsoResolve(context: BytecodeContext, fingerprint: MethodFingerprint) =
also { resolve(context, fingerprint.resultOrThrow().classDef) }.resultOrThrow()

View File

@ -0,0 +1,193 @@
package app.revanced.util.fingerprint
import app.revanced.patcher.data.BytecodeContext
import app.revanced.patcher.fingerprint.MethodFingerprint
import app.revanced.patcher.fingerprint.MethodFingerprintResult
import com.android.tools.smali.dexlib2.Opcode
import com.android.tools.smali.dexlib2.iface.ClassDef
import com.android.tools.smali.dexlib2.iface.Method
import com.android.tools.smali.dexlib2.iface.instruction.ReferenceInstruction
import com.android.tools.smali.dexlib2.iface.reference.StringReference
private typealias StringMatch = MethodFingerprintResult.MethodFingerprintScanResult.StringsScanResult.StringMatch
private typealias StringsScanResult = MethodFingerprintResult.MethodFingerprintScanResult.StringsScanResult
/**
* Represents the [MethodFingerprint] for a method.
* @param returnType The return type of the method.
* @param accessFlags The access flags of the method.
* @param parameters The parameters of the method.
* @param opcodes The list of opcodes of the method.
* @param strings A list of strings which a method contains.
* @param customFingerprint A custom condition for this fingerprint.
* A `null` opcode is equals to an unknown opcode.
*/
abstract class MultiMethodFingerprint(
val returnType: String? = null,
val accessFlags: Int? = null,
val parameters: Iterable<String>? = null,
val opcodes: Iterable<Opcode?>? = null,
val strings: Iterable<String>? = null,
val customFingerprint: ((methodDef: Method, classDef: ClassDef) -> Boolean)? = null
) {
/**
* The result of the [MethodFingerprint].
*/
var result = mutableListOf<MethodFingerprintResult>()
private var resolved = false
companion object {
/**
* Resolve a list of [MethodFingerprint] against a list of [ClassDef].
*
* @param classes The classes on which to resolve the [MethodFingerprint] in.
* @param context The [BytecodeContext] to host proxies.
* @return True if the resolution was successful, false otherwise.
*/
fun Iterable<MultiMethodFingerprint>.resolve(context: BytecodeContext, classes: Iterable<ClassDef>) {
for (fingerprint in this) { // For each fingerprint
if (fingerprint.resolved) continue
for (classDef in classes) // search through all classes for the fingerprint
fingerprint.resolve(context, classDef)
fingerprint.resolved = true
}
}
/**
* Resolve a [MethodFingerprint] against a [ClassDef].
*
* @param forClass The class on which to resolve the [MethodFingerprint] in.
* @param context The [BytecodeContext] to host proxies.
* @return True if the resolution was successful, false otherwise.
*/
fun MultiMethodFingerprint.resolve(context: BytecodeContext, forClass: ClassDef): Boolean {
for (method in forClass.methods)
if (this.resolve(context, method, forClass))
return true
return false
}
/**
* Resolve a [MethodFingerprint] against a [Method].
*
* @param method The class on which to resolve the [MethodFingerprint] in.
* @param forClass The class on which to resolve the [MethodFingerprint].
* @param context The [BytecodeContext] to host proxies.
* @return True if the resolution was successful or if the fingerprint is already resolved, false otherwise.
*/
fun MultiMethodFingerprint.resolve(context: BytecodeContext, method: Method, forClass: ClassDef): Boolean {
val methodFingerprint = this
if (methodFingerprint.returnType != null && !method.returnType.startsWith(methodFingerprint.returnType))
return false
if (methodFingerprint.accessFlags != null && methodFingerprint.accessFlags != method.accessFlags)
return false
fun parametersEqual(
parameters1: Iterable<CharSequence>, parameters2: Iterable<CharSequence>
): Boolean {
if (parameters1.count() != parameters2.count()) return false
val iterator1 = parameters1.iterator()
parameters2.forEach {
if (!it.startsWith(iterator1.next())) return false
}
return true
}
if (methodFingerprint.parameters != null && !parametersEqual(
methodFingerprint.parameters, // TODO: parseParameters()
method.parameterTypes
)
) return false
@Suppress("UNNECESSARY_NOT_NULL_ASSERTION")
if (methodFingerprint.customFingerprint != null && !methodFingerprint.customFingerprint!!(method, forClass))
return false
val stringsScanResult = if (methodFingerprint.strings != null) {
StringsScanResult(
buildList {
val implementation = method.implementation ?: return false
val stringsList = methodFingerprint.strings.toMutableList()
implementation.instructions.forEachIndexed { instructionIndex, instruction ->
if (
instruction.opcode != Opcode.CONST_STRING &&
instruction.opcode != Opcode.CONST_STRING_JUMBO
) return@forEachIndexed
val string = ((instruction as ReferenceInstruction).reference as StringReference).string
val index = stringsList.indexOfFirst(string::contains)
if (index == -1) return@forEachIndexed
add(StringMatch(string, instructionIndex))
stringsList.removeAt(index)
}
if (stringsList.isNotEmpty()) return false
}
)
} else null
val patternScanResult = if (methodFingerprint.opcodes != null) {
method.implementation?.instructions ?: return false
method.patternScan(methodFingerprint) ?: return false
} else null
methodFingerprint.result.add(
MethodFingerprintResult(
method,
forClass,
MethodFingerprintResult.MethodFingerprintScanResult(
patternScanResult,
stringsScanResult
),
context
)
)
return true
}
private fun Method.patternScan(
fingerprint: MultiMethodFingerprint
): MethodFingerprintResult.MethodFingerprintScanResult.PatternScanResult? {
val instructions = this.implementation!!.instructions
val pattern = fingerprint.opcodes!!
val instructionLength = instructions.count()
val patternLength = pattern.count()
for (index in 0 until instructionLength) {
var patternIndex = 0
while (index + patternIndex < instructionLength) {
val originalOpcode = instructions.elementAt(index + patternIndex).opcode
val patternOpcode = pattern.elementAt(patternIndex)
if (patternOpcode != null && patternOpcode.ordinal != originalOpcode.ordinal) {
// reaching maximum threshold (0) means,
// the pattern does not match to the current instructions
break
}
if (patternIndex < patternLength - 1) {
// if the entire pattern has not been scanned yet
// continue the scan
patternIndex++
continue
}
return MethodFingerprintResult.MethodFingerprintScanResult.PatternScanResult(
index,
index + patternIndex
)
}
}
return null
}
}
}

View File

@ -0,0 +1,16 @@
package app.revanced.util.patch
import app.revanced.patcher.data.BytecodeContext
import app.revanced.patcher.fingerprint.MethodFingerprint
import app.revanced.patcher.patch.BytecodePatch
import app.revanced.util.fingerprint.MultiMethodFingerprint
import app.revanced.util.fingerprint.MultiMethodFingerprint.Companion.resolve
abstract class MultiMethodBytecodePatch(
val fingerprints: Set<MethodFingerprint> = setOf(),
val multiFingerprints: Set<MultiMethodFingerprint> = setOf()
) : BytecodePatch(fingerprints) {
override fun execute(context: BytecodeContext) {
multiFingerprints.resolve(context, context.classes)
}
}