From 87f3b37e034e054397ecc3035cf3f6dbab6ddcc1 Mon Sep 17 00:00:00 2001
From: Kavin <20838718+FireMasterK@users.noreply.github.com>
Date: Thu, 12 Dec 2024 17:08:38 +0530
Subject: [PATCH] Fix remaining todos in the code.

The PoTokenProvider class is now expected to handle calls from multiple threads for thread safety.
---
 .../services/youtube/PoTokenProvider.java     |  2 +
 .../extractors/YoutubeStreamExtractor.java    | 41 +++++++++++++++----
 2 files changed, 35 insertions(+), 8 deletions(-)

diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/PoTokenProvider.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/PoTokenProvider.java
index d3d2a64552..13323184c9 100644
--- a/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/PoTokenProvider.java
+++ b/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/PoTokenProvider.java
@@ -5,6 +5,8 @@
 /**
  * An interface to provide poTokens to YouTube player requests.
  *
+ * @implNote This interface is expected to be thread-safe, as it may be accessed by multiple threads.
+ *
  * <p>
  * On some major clients, YouTube requires that the integrity of the device passes some checks to
  * allow playback.
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeStreamExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeStreamExtractor.java
index f2c0a3d114..ac60cd10ac 100644
--- a/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeStreamExtractor.java
+++ b/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeStreamExtractor.java
@@ -116,6 +116,8 @@ public class YoutubeStreamExtractor extends StreamExtractor {
     private String androidCpn;
     private String tvHtml5SimplyEmbedCpn;
 
+    private static boolean forceFetchIosClient;
+
     public YoutubeStreamExtractor(final StreamingService service, final LinkHandler linkHandler) {
         super(service, linkHandler);
     }
@@ -781,9 +783,7 @@ public void onFetchPage(@Nonnull final Downloader downloader)
 
         checkPlayabilityStatus(playerResponse, playerResponse.getObject("playabilityStatus"));
 
-        if (webPoTokenResult == null) {
-            // TODO: add ability to force fetch iOS player response even if
-            //  webPoTokenResult != null
+        if (forceFetchIosClient || webPoTokenResult == null) {
             iosCpn = generateContentPlaybackNonce();
             final JsonObject iosPlayerResponse = YoutubeStreamHelper.getIosPlayerResponse(
                     contentCountry, localization, videoId, iosCpn);
@@ -795,10 +795,10 @@ public void onFetchPage(@Nonnull final Downloader downloader)
             final JsonObject iosStreamingData = iosPlayerResponse.getObject(STREAMING_DATA);
             if (!isNullOrEmpty(iosStreamingData)) {
                 this.iosStreamingData = iosStreamingData;
-                // TODO: only assign playerCaptionsTracklistRenderer when iOS client
-                //  fetching is not forced
-                playerCaptionsTracklistRenderer = iosPlayerResponse.getObject("captions")
-                        .getObject("playerCaptionsTracklistRenderer");
+                if (!forceFetchIosClient) {
+                    playerCaptionsTracklistRenderer = iosPlayerResponse.getObject("captions")
+                            .getObject("playerCaptionsTracklistRenderer");
+                }
             }
         }
 
@@ -1515,8 +1515,33 @@ public List<MetaInfo> getMetaInfo() throws ParsingException {
                 .getArray("contents"));
     }
 
+    /**
+     * Sets the {@link PoTokenProvider} instance to be used for fetching poTokens.
+     *
+     * <p>
+     * This method allows setting an implementation of {@link PoTokenProvider} which will be used
+     * to obtain poTokens required for YouTube player requests. These tokens are used by YouTube to verify the
+     * integrity of the device and may be necessary for playback at times.
+     * </p>
+     *
+     * @param poTokenProvider the {@link PoTokenProvider} instance to set
+     */
     public static void setPoTokenProvider(@Nullable final PoTokenProvider poTokenProvider) {
-        // TODO: document the method and handle concurrent calls
         YoutubeStreamExtractor.poTokenProvider = poTokenProvider;
     }
+
+    /**
+     * Sets whether to force fetch the iOS player response even if the webPoTokenResult is not null.
+     *
+     * <p>
+     * This method allows setting a flag to force the fetching of the iOS player response, even if a
+     * valid webPoTokenResult is available. This can be useful in scenarios where streams from the iOS player
+     * response is preferred.
+     * </p>
+     *
+     * @param forceFetchIosClient a boolean flag indicating whether to force fetch the iOS player response
+     */
+    public static void setForceFetchIosClient(boolean forceFetchIosClient) {
+        YoutubeStreamExtractor.forceFetchIosClient = forceFetchIosClient;
+    }
 }