Skip to content
This repository has been archived by the owner on Oct 26, 2024. It is now read-only.

Commit

Permalink
- Handle DeArrow connection errors.
Browse files Browse the repository at this point in the history 
- Fix validation of API url.
  • Loading branch information
@LisoUseInAIKyrios
LisoUseInAIKyrios committed Dec 5, 2023
1 parent 57f2bf9 commit 6f8c6f7
Show file tree
Hide file tree
Showing 3 changed files with 162 additions and 55 deletions.
204 changes: 151 additions & 53 deletions app/src/main/java/app/revanced/integrations/patches/AlternativeThumbnailsPatch.java
View file
Original file line number Diff line number Diff line change
@@ -1,26 +1,36 @@
package app.revanced.integrations.patches;

import android.net.Uri;

import androidx.annotation.GuardedBy;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import app.revanced.integrations.settings.SettingsEnum;
import app.revanced.integrations.utils.LogHelper;
import app.revanced.integrations.utils.ReVancedUtils;

import org.chromium.net.UrlResponseInfo;

import java.io.IOException;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.concurrent.ExecutionException;

import app.revanced.integrations.settings.SettingsEnum;
import app.revanced.integrations.utils.LogHelper;
import app.revanced.integrations.utils.ReVancedUtils;

/**
* Alternative YouTube thumbnails, showing the beginning/middle/end of the video.
* Alternative YouTube thumbnails.
* <p>
* Can show YouTube provided screen captures of beginning/middle/end of the video.
* (ie: sd1.jpg, sd2.jpg, sd3.jpg).
* <p>
* Has an additional option to use 'fast' thumbnails,
* Or can show crowd sourced thumbnails provided by DeArrow (http://dearrow.ajay.app).
* <p>
* Or can use DeArrow and fall back to screen captures if DeArrow is not available.
* <p>
* Has an additional option to use 'fast' video still thumbnails,
* where it forces sd thumbnail quality and skips verifying if the alt thumbnail image exists.
* The UI loading time will be the same or better than using the the original thumbnails,
* but thumbnails will initially fail to load for all live streams, unreleased, and occasionally very old videos.
Expand All @@ -36,22 +46,53 @@
* @noinspection unused
*/
public final class AlternativeThumbnailsPatch {
@Nullable
private static final Uri dearrowApiUri = Uri.parse(SettingsEnum.ALT_THUMBNAIL_DEARROW_API_URL.getString());

private static final Uri dearrowApiUri;
/**
* The scheme and host of {@link #dearrowApiUri}.
*/
private static final String deArrowApiUrlPrefix;

/**
* How long to temporarily turn off DeArrow if it fails for any reason.
*/
private static final long DEARROW_CONNECTION_FAILURE_BACKOFF_MILLISECONDS = 2 * 60 * 1000; // 2 Minutes.

/**
* If non zero, then the system time of when DeArrow API calls can resume.
*/
private static volatile long timeToResumeDeArrowAPICalls;

static {
// Fix any bad imported data.
dearrowApiUri = validateSettings();
deArrowApiUrlPrefix = dearrowApiUri.getScheme() + "://" + dearrowApiUri.getHost() + "/";
}

/**
* Fix any bad imported data.
*/
private static Uri validateSettings() {
final int mode = SettingsEnum.ALT_THUMBNAIL_MODE.getInt();
if(mode < 1 || mode > 3) {
LogHelper.printException(() -> "Invalid alt thumbnail mode: " + mode);
SettingsEnum.ALT_THUMBNAIL_MODE.saveValue(SettingsEnum.ALT_THUMBNAIL_MODE.defaultValue);
if (mode < 1 || mode > 4) {
ReVancedUtils.showToastLong("Invalid Alternative thumbnail mode: "
+ mode + ". Using default");
SettingsEnum.ALT_THUMBNAIL_MODE.resetToDefault();
}

final int altThumbnailType = SettingsEnum.ALT_THUMBNAIL_TYPE.getInt();
final int altThumbnailType = SettingsEnum.ALT_THUMBNAIL_STILL_TYPE.getInt();
if (altThumbnailType < 1 || altThumbnailType > 3) {
LogHelper.printException(() -> "Invalid alt thumbnail type: " + altThumbnailType);
SettingsEnum.ALT_THUMBNAIL_TYPE.saveValue(SettingsEnum.ALT_THUMBNAIL_TYPE.defaultValue);
ReVancedUtils.showToastLong("Invalid Alternative still thumbnail type: "
+ altThumbnailType + ". Using default");
SettingsEnum.ALT_THUMBNAIL_STILL_TYPE.resetToDefault();
}

Uri apiUri = Uri.parse(SettingsEnum.ALT_THUMBNAIL_DEARROW_API_URL.getString());
if (apiUri.getScheme() == null || apiUri.getHost() == null) {
ReVancedUtils.showToastLong("Invalid DeArrow API URL. Using default");
SettingsEnum.ALT_THUMBNAIL_DEARROW_API_URL.resetToDefault();
return validateSettings();
}
return apiUri;
}

/**
Expand Down Expand Up @@ -93,11 +134,6 @@ private static String buildYoutubeVideoStillURL(DecodedThumbnailUrl decodedUrl)
*/
@NonNull
private static String buildDeArrowThumbnailURL(String videoId, String fallbackUrl) {
// Use fallback if parsing API URI failed.
if (dearrowApiUri == null) {
return fallbackUrl;
}

// Build thumbnail request url.
// See https://github.com/ajayyy/DeArrowThumbnailCache/blob/29eb4359ebdf823626c79d944a901492d760bbbc/app.py#L29.
return dearrowApiUri
Expand All @@ -109,6 +145,32 @@ private static String buildDeArrowThumbnailURL(String videoId, String fallbackUr
.toString();
}

private static boolean urlIsDeArrow(@NonNull String imageUrl) {
return imageUrl.startsWith(deArrowApiUrlPrefix);
}

/**
* @return If this client has not recently experience any DeArrow API errors.
*/
private static boolean canUseDeArrowAPI() {
if (timeToResumeDeArrowAPICalls == 0) {
return true;
}
if (System.currentTimeMillis() > timeToResumeDeArrowAPICalls) {
LogHelper.printDebug(() -> "Resuming DeArrow API calls");
timeToResumeDeArrowAPICalls = 0;
return true;
}
return false;
}

private static void handleDeArrowError(UrlResponseInfo responseInfo) {
// TODO? Add a setting to show a toast on DeArrow failure?
LogHelper.printDebug(() -> "Encountered DeArrow error. Backing off for "
+ DEARROW_CONNECTION_FAILURE_BACKOFF_MILLISECONDS + "ms: " + responseInfo);
timeToResumeDeArrowAPICalls = System.currentTimeMillis() + DEARROW_CONNECTION_FAILURE_BACKOFF_MILLISECONDS;
}

/**
* Injection point. Called off the main thread and by multiple threads at the same time.
*
Expand All @@ -130,22 +192,24 @@ public static String overrideImageURL(String originalUrl) {
LogHelper.printDebug(() -> "Original url: " + decodedUrl.sanitizedUrl);

final StringBuilder thumbnailUrlBuilder = new StringBuilder();
if (thumbnailMode.usingDeArrow()) {
if (thumbnailMode.usingDeArrow() && canUseDeArrowAPI()) {
// Get fallback URL.
final String fallbackUrl = thumbnailMode == AlternativeThumbnailMode.DEARROW_OR_VIDEO_STILLS
? buildYoutubeVideoStillURL(decodedUrl)
: decodedUrl.sanitizedUrl;

final var thumbnailURL = buildDeArrowThumbnailURL(decodedUrl.videoId, fallbackUrl);
thumbnailUrlBuilder.append(thumbnailURL);
} else {
} else if (thumbnailMode.usingVideoStills()) {
// Get video still URL.
final var thumbnailUrl = buildYoutubeVideoStillURL(decodedUrl);
thumbnailUrlBuilder.append(thumbnailUrl);

// URL tracking parameters. Presumably they are to determine if a user has viewed a thumbnail.
// This likely is used for recommendations, so they are retained if present.
thumbnailUrlBuilder.append(decodedUrl.urlTrackingParameters);
} else {
return originalUrl; // Recently experienced DeArrow failure and video stills are not enabled.
}

final var thumbnailUrl = thumbnailUrlBuilder.toString();
Expand All @@ -165,29 +229,65 @@ public static String overrideImageURL(String originalUrl) {
*/
public static void handleCronetSuccess(@NonNull UrlResponseInfo responseInfo) {
try {
// 404 and alt thumbnails is using video stills
if (responseInfo.getHttpStatusCode() == 404
&& AlternativeThumbnailMode.getCurrent().usingVideoStills()) {
// Fast alt thumbnails is enabled and the thumbnail is not available.
// The video is:
// - live stream
// - upcoming unreleased video
// - very old
// - very low view count
// Take note of this, so if the image reloads the original thumbnail will be used.
DecodedThumbnailUrl decodedUrl = DecodedThumbnailUrl.decodeImageUrl(responseInfo.getUrl());
if (decodedUrl == null) {
return; // Not a thumbnail.
final int responseCode = responseInfo.getHttpStatusCode();
if (responseCode != 200) {
AlternativeThumbnailMode currentMode = AlternativeThumbnailMode.getCurrent();
String url = responseInfo.getUrl();
// Do not log the responseInfo unless it's known to be a DeArrow call.
// Otherwise this can log user details found in regular YouTube non Alt Thumbnails traffic.
LogHelper.printDebug(() -> "handleCronetSuccess responseCode: " + responseCode + " url: " + url);

if (currentMode.usingDeArrow() && urlIsDeArrow(url)) {
handleDeArrowError(responseInfo);
}

ThumbnailQuality quality = ThumbnailQuality.altImageNameToQuality(decodedUrl.imageQuality);
if (quality == null) {
// Video is a short or unknown quality, but the url returned 404. Should never happen.
LogHelper.printDebug(() -> "Failed to load unknown url: " + decodedUrl.sanitizedUrl);
return;
if (currentMode.usingVideoStills() && responseCode == 404) {
// Fast alt thumbnails is enabled and the thumbnail is not available.
// The video is:
// - live stream
// - upcoming unreleased video
// - very old
// - very low view count
// Take note of this, so if the image reloads the original thumbnail will be used.
DecodedThumbnailUrl decodedUrl = DecodedThumbnailUrl.decodeImageUrl(url);
if (decodedUrl == null) {
return; // Not a thumbnail.
}

ThumbnailQuality quality = ThumbnailQuality.altImageNameToQuality(decodedUrl.imageQuality);
if (quality == null) {
// Video is a short or unknown quality, but the url returned 404. Should never happen.
LogHelper.printDebug(() -> "Failed to load unknown url: " + decodedUrl.sanitizedUrl);
return;
}

VerifiedQualities.setAltThumbnailDoesNotExist(decodedUrl.videoId, quality);
}
}
} catch (Exception ex) {
LogHelper.printException(() -> "Alt thumbnails callback failure", ex);
}
}

VerifiedQualities.setAltThumbnailDoesNotExist(decodedUrl.videoId, quality);
/**
* Injection point.
*/
public static void handleCronetFailure(@Nullable UrlResponseInfo responseInfo, IOException exception) {
try {
LogHelper.printDebug(() -> "handleCronetFailure exception: " + exception);
AlternativeThumbnailMode currentMode = AlternativeThumbnailMode.getCurrent();

if (currentMode.usingDeArrow()) {
// If the DeArrow API host name does not resolve, then no response is provided
// and the IOException (CronetException) provides no information to detect this situation.
//
// For now, treat this as a DeArrow failure but only if the API is not set to default.
// This may incorrectly turn off DeArrow for non alt thumbnail errors,
// but that should be rare since so few users will change the API url.
if ((responseInfo == null && !SettingsEnum.ALT_THUMBNAIL_DEARROW_API_URL.isSetToDefault())
|| (responseInfo != null && urlIsDeArrow(responseInfo.getUrl()))) {
handleDeArrowError(responseInfo);
}
}
} catch (Exception ex) {
LogHelper.printException(() -> "Alt thumbnails callback failure", ex);
Expand Down Expand Up @@ -278,7 +378,7 @@ static ThumbnailQuality getQualityToUse(@NonNull String originalSize) {
}

String getAltImageNameToUse() {
return altImageName + SettingsEnum.ALT_THUMBNAIL_TYPE.getInt();
return altImageName + SettingsEnum.ALT_THUMBNAIL_STILL_TYPE.getInt();
}
}

Expand Down Expand Up @@ -515,27 +615,25 @@ public boolean usingDeArrow() {
return this == DEARROW_OR_CREATOR_PROVIDED || this == DEARROW_OR_VIDEO_STILLS;
}

@Nullable
@NonNull
public static AlternativeThumbnailMode byId(int id) {
// Could use the Enum ordinal and use values()[id],
// but then the ids would start at 0.
// Since only 4 ids exist this isn't a big deal
// and little overhead is needed to manually compare 4 int values.
for (final var mode : AlternativeThumbnailMode.values()) {
if(mode.id == id) {
if (mode.id == id) {
return mode;
}
}

return null;
// User imported bad data and did not restart the app. Fix the settings and continue.
validateSettings();
return byId(id);
}

@NonNull
public static AlternativeThumbnailMode getCurrent() {
var mode = byId(SettingsEnum.ALT_THUMBNAIL_MODE.getInt());

if (mode == null) {
// Fallback to stock behaviour.
mode = ORIGINAL;
}

return mode;
return byId(SettingsEnum.ALT_THUMBNAIL_MODE.getInt());
}
}
}
11 changes: 10 additions & 1 deletion app/src/main/java/app/revanced/integrations/settings/SettingsEnum.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@ public enum SettingsEnum {

// Layout
ALT_THUMBNAIL_MODE("revanced_alt_thumbnail_mode", INTEGER, 1),
ALT_THUMBNAIL_TYPE("revanced_alt_thumbnail_type", INTEGER, 2),
@Deprecated DEPRECATED_ALT_THUMBNAIL_TYPE("revanced_alt_thumbnail_type", INTEGER, 2),
ALT_THUMBNAIL_STILL_TYPE("revanced_alt_thumbnail_still_type", INTEGER, 2),
ALT_THUMBNAIL_FAST_QUALITY("revanced_alt_thumbnail_fast_quality", BOOLEAN, FALSE),
ALT_THUMBNAIL_DEARROW_API_URL("revanced_alt_thumbnail_dearrow_api_url", STRING,
"https://dearrow-thumb.ajay.app/api/v1/getThumbnail", true),
Expand Down Expand Up @@ -405,6 +406,7 @@ private static void loadAllSettings() {
migrateOldSettingToNew(DISABLE_FINE_SCRUBBING_GESTURE, DISABLE_PRECISE_SEEKING_GESTURE);
migrateOldSettingToNew(SHOW_OLD_VIDEO_QUALITY_MENU, RESTORE_OLD_VIDEO_QUALITY_MENU);
migrateOldSettingToNew(ENABLE_OLD_SEEKBAR_THUMBNAILS, RESTORE_OLD_SEEKBAR_THUMBNAILS);
migrateOldSettingToNew(DEPRECATED_ALT_THUMBNAIL_TYPE, ALT_THUMBNAIL_STILL_TYPE);

// Do _not_ delete this SB private user id migration property until sometime in 2024.
// This is the only setting that cannot be reconfigured if lost,
Expand Down Expand Up @@ -524,6 +526,13 @@ public void saveValue(@NonNull Object newValue) {
}
}

/**
* Identical to calling {@link #saveValue(Object)} using {@link #defaultValue}.
*/
public void resetToDefault() {
saveValue(defaultValue);
}

/**
* @return if this setting can be configured and used.
* <p>
Expand Down
2 changes: 1 addition & 1 deletion dummy/src/main/java/org/chromium/net/UrlResponseInfo.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
//dummy class
public abstract class UrlResponseInfo {

public abstract String getUrl();
public abstract String getUrl(); // Can return NULL for some failures.

public abstract int getHttpStatusCode();

Expand Down

0 comments on commit 6f8c6f7

Please sign in to comment.