From d82de2e11912796aa23c5b2ad68f4298cab71e3a Mon Sep 17 00:00:00 2001 From: LisoUseInAIKyrios <118716522+LisoUseInAIKyrios@users.noreply.github.com> Date: Wed, 27 Nov 2024 16:32:58 +0400 Subject: [PATCH 1/5] feat(TikTok): Add ReVanced settings about screen --- .../preference/ReVancedAboutPreference.java | 105 ++++++++++++------ .../ReVancedTikTokAboutPreference.java | 56 ++++++++++ .../ExtensionPreferenceCategory.java | 3 + .../resources/addresources/values/strings.xml | 3 +- 4 files changed, 134 insertions(+), 33 deletions(-) create mode 100644 extensions/shared/src/main/java/app/revanced/extension/tiktok/settings/preference/ReVancedTikTokAboutPreference.java diff --git a/extensions/shared/src/main/java/app/revanced/extension/shared/settings/preference/ReVancedAboutPreference.java b/extensions/shared/src/main/java/app/revanced/extension/shared/settings/preference/ReVancedAboutPreference.java index 89fbe80e90..dd1ba34173 100644 --- a/extensions/shared/src/main/java/app/revanced/extension/shared/settings/preference/ReVancedAboutPreference.java +++ b/extensions/shared/src/main/java/app/revanced/extension/shared/settings/preference/ReVancedAboutPreference.java @@ -1,6 +1,5 @@ package app.revanced.extension.shared.settings.preference; -import static app.revanced.extension.shared.StringRef.sf; import static app.revanced.extension.shared.StringRef.str; import static app.revanced.extension.youtube.requests.Route.Method.GET; @@ -13,6 +12,8 @@ import android.graphics.Color; import android.net.Uri; import android.os.Bundle; +import android.os.Handler; +import android.os.Looper; import android.preference.Preference; import android.util.AttributeSet; import android.view.Window; @@ -37,7 +38,7 @@ import app.revanced.extension.youtube.requests.Route; /** - * Opens a dialog showing the links from {@link SocialLinksRoutes}. + * Opens a dialog showing official links. */ @SuppressWarnings({"unused", "deprecation"}) public class ReVancedAboutPreference extends Preference { @@ -72,7 +73,16 @@ protected int getDarkColor() { return Color.BLACK; } - private String createDialogHtml(WebLink[] socialLinks) { + /** + * Apps that do not support bundling resources must override this. + * + * @return A localized string to display for the key. + */ + protected String getString(String key, Object ... args) { + return str(key, args); + } + + private String createDialogHtml(WebLink[] aboutLinks) { final boolean isNetworkConnected = Utils.isNetworkConnected(); StringBuilder builder = new StringBuilder(); @@ -91,7 +101,7 @@ private String createDialogHtml(WebLink[] socialLinks) { builder.append(""); + + "src=\"" + AboutLinksRoutes.aboutLogoUrl + "\" />"); } String patchesVersion = Utils.getPatchesReleaseVersion(); @@ -103,29 +113,29 @@ private String createDialogHtml(WebLink[] socialLinks) { builder.append("

") // Replace hyphens with non breaking dashes so the version number does not break lines. - .append(useNonBreakingHyphens(str("revanced_settings_about_links_body", patchesVersion))) + .append(useNonBreakingHyphens(getString("revanced_settings_about_links_body", patchesVersion))) .append("

"); // Add a disclaimer if using a dev release. if (patchesVersion.contains("dev")) { builder.append("

") // English text 'Pre-release' can break lines. - .append(useNonBreakingHyphens(str("revanced_settings_about_links_dev_header"))) + .append(useNonBreakingHyphens(getString("revanced_settings_about_links_dev_header"))) .append("

"); builder.append("

") - .append(str("revanced_settings_about_links_dev_body")) + .append(getString("revanced_settings_about_links_dev_body")) .append("

"); } builder.append("

") - .append(str("revanced_settings_about_links_header")) + .append(getString("revanced_settings_about_links_header")) .append("

"); builder.append("
"); - for (WebLink social : socialLinks) { + for (WebLink link : aboutLinks) { builder.append("
"); - builder.append(String.format("%s", social.url, social.name)); + builder.append(String.format("%s", link.url, link.name)); builder.append("
"); } builder.append("
"); @@ -137,25 +147,49 @@ private String createDialogHtml(WebLink[] socialLinks) { { setOnPreferenceClickListener(pref -> { // Show a progress spinner if the social links are not fetched yet. - if (!SocialLinksRoutes.hasFetchedLinks() && Utils.isNetworkConnected()) { + if (!AboutLinksRoutes.hasFetchedLinks() && Utils.isNetworkConnected()) { + // Show a progress spinner, but only if the api fetch + // takes more than a quarter of a second. + final long delayToShowProgressSpinner = 250; ProgressDialog progress = new ProgressDialog(getContext()); progress.setProgressStyle(ProgressDialog.STYLE_SPINNER); - progress.show(); - Utils.runOnBackgroundThread(() -> fetchLinksAndShowDialog(progress)); + + Handler handler = new Handler(Looper.getMainLooper()); + Runnable showDialogRunnable = progress::show; + handler.postDelayed(showDialogRunnable, delayToShowProgressSpinner); + + Utils.runOnBackgroundThread(() -> + fetchLinksAndShowDialog(handler, showDialogRunnable, progress)); } else { // No network call required and can run now. - fetchLinksAndShowDialog(null); + fetchLinksAndShowDialog(null, null, null); } return false; }); } - private void fetchLinksAndShowDialog(@Nullable ProgressDialog progress) { - WebLink[] socialLinks = SocialLinksRoutes.fetchSocialLinks(); - String htmlDialog = createDialogHtml(socialLinks); + private void fetchLinksAndShowDialog(@Nullable Handler handler, + Runnable showDialogRunnable, + @Nullable ProgressDialog progress) { + WebLink[] links = AboutLinksRoutes.fetchAboutLinks(); + String htmlDialog = createDialogHtml(links); + + // Enable to randomly force a delay to debug the spinner logic. + final boolean debugSpinnerDelayLogic = false; + //noinspection ConstantConditions + if (debugSpinnerDelayLogic && handler != null) { + try { + if (Math.random() < 0.5f) Thread.sleep((long) (Math.random() * 4000)); + } catch (InterruptedException e) { + throw new RuntimeException(e); + } + } Utils.runOnMainThreadNowOrLater(() -> { + if (handler != null) { + handler.removeCallbacks(showDialogRunnable); + } if (progress != null) { progress.dismiss(); } @@ -224,7 +258,7 @@ public boolean shouldOverrideUrlLoading(WebView view, String url) { class WebLink { final boolean preferred; - final String name; + String name; final String url; WebLink(JSONObject json) throws JSONException { @@ -243,7 +277,7 @@ class WebLink { @NonNull @Override public String toString() { - return "ReVancedSocialLink{" + + return "WebLink{" + "preferred=" + preferred + ", name='" + name + '\'' + ", url='" + url + '\'' + @@ -251,25 +285,21 @@ public String toString() { } } -class SocialLinksRoutes { +class AboutLinksRoutes { /** - * Simple link to the website donate page, - * rather than fetching and parsing the donation links using the API. + * Backup icon url if the API call fails. */ - public static final WebLink DONATE_LINK = new WebLink(true, - sf("revanced_settings_about_links_donate").toString(), - "https://revanced.app/donate"); + public static volatile String aboutLogoUrl = "https://revanced.app/favicon.ico"; /** * Links to use if fetch links api call fails. */ private static final WebLink[] NO_CONNECTION_STATIC_LINKS = { - new WebLink(true, "ReVanced.app", "https://revanced.app"), - DONATE_LINK, + new WebLink(true, "ReVanced.app", "https://revanced.app") }; - private static final String SOCIAL_LINKS_PROVIDER = "https://api.revanced.app/v2"; - private static final Route.CompiledRoute GET_SOCIAL = new Route(GET, "/socials").compile(); + private static final String SOCIAL_LINKS_PROVIDER = "https://api.revanced.app/v4"; + private static final Route.CompiledRoute GET_SOCIAL = new Route(GET, "/about").compile(); @Nullable private static volatile WebLink[] fetchedLinks; @@ -278,7 +308,7 @@ static boolean hasFetchedLinks() { return fetchedLinks != null; } - static WebLink[] fetchSocialLinks() { + static WebLink[] fetchAboutLinks() { try { if (hasFetchedLinks()) return fetchedLinks; @@ -298,11 +328,22 @@ static WebLink[] fetchSocialLinks() { } JSONObject json = Requester.parseJSONObjectAndDisconnect(connection); - JSONArray socials = json.getJSONArray("socials"); + aboutLogoUrl = json.getJSONObject("branding").getString("logo"); List links = new ArrayList<>(); - links.add(DONATE_LINK); // Show donate link first. + JSONArray donations = json.getJSONObject("donations").getJSONArray("links"); + for (int i = 0, length = donations.length(); i < length; i++) { + WebLink link = new WebLink(donations.getJSONObject(i)); + if (link.preferred) { + // This could be localized, but TikTok does not support localized resources. + // All link names returned by the api are also non localized. + link.name = "Donate"; + links.add(link); + } + } + + JSONArray socials = json.getJSONArray("socials"); for (int i = 0, length = socials.length(); i < length; i++) { WebLink link = new WebLink(socials.getJSONObject(i)); links.add(link); diff --git a/extensions/shared/src/main/java/app/revanced/extension/tiktok/settings/preference/ReVancedTikTokAboutPreference.java b/extensions/shared/src/main/java/app/revanced/extension/tiktok/settings/preference/ReVancedTikTokAboutPreference.java new file mode 100644 index 0000000000..624c2a45fa --- /dev/null +++ b/extensions/shared/src/main/java/app/revanced/extension/tiktok/settings/preference/ReVancedTikTokAboutPreference.java @@ -0,0 +1,56 @@ +package app.revanced.extension.tiktok.settings.preference; + +import android.content.Context; +import android.util.AttributeSet; + +import java.util.Map; + +import app.revanced.extension.shared.Logger; +import app.revanced.extension.shared.settings.preference.ReVancedAboutPreference; + +@SuppressWarnings("unused") +public class ReVancedTikTokAboutPreference extends ReVancedAboutPreference { + + /** + * Because resources cannot be added to TikTok, + * these strings are copied from the shared strings.xml file. + * + * Changes here must also be made in strings.xml + */ + private final Map aboutStrings = Map.of( + "revanced_settings_about_links_body", "You are using ReVanced Patches version %s", + "revanced_settings_about_links_dev_header", "Note", + "revanced_settings_about_links_dev_body", "This version is a pre-release and you may experience unexpected issues", + "revanced_settings_about_links_header", "Official links" + ); + + { + //noinspection deprecation + setTitle("Donate"); + } + + public ReVancedTikTokAboutPreference(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes) { + super(context, attrs, defStyleAttr, defStyleRes); + } + public ReVancedTikTokAboutPreference(Context context, AttributeSet attrs, int defStyleAttr) { + super(context, attrs, defStyleAttr); + } + public ReVancedTikTokAboutPreference(Context context, AttributeSet attrs) { + super(context, attrs); + } + public ReVancedTikTokAboutPreference(Context context) { + super(context); + } + + @Override + protected String getString(String key, Object ... args) { + String format = aboutStrings.get(key); + + if (format == null) { + Logger.printException(() -> "Unknown key: " + key); + return ""; + } + + return String.format(format, args); + } +} diff --git a/extensions/shared/src/main/java/app/revanced/extension/tiktok/settings/preference/categories/ExtensionPreferenceCategory.java b/extensions/shared/src/main/java/app/revanced/extension/tiktok/settings/preference/categories/ExtensionPreferenceCategory.java index ad49df688b..d98217c03e 100644 --- a/extensions/shared/src/main/java/app/revanced/extension/tiktok/settings/preference/categories/ExtensionPreferenceCategory.java +++ b/extensions/shared/src/main/java/app/revanced/extension/tiktok/settings/preference/categories/ExtensionPreferenceCategory.java @@ -4,6 +4,7 @@ import android.preference.PreferenceScreen; import app.revanced.extension.shared.settings.BaseSettings; +import app.revanced.extension.tiktok.settings.preference.ReVancedTikTokAboutPreference; import app.revanced.extension.tiktok.settings.preference.TogglePreference; @SuppressWarnings("deprecation") @@ -20,6 +21,8 @@ public boolean getSettingsStatus() { @Override public void addPreferences(Context context) { + addPreference(new ReVancedTikTokAboutPreference(context)); + addPreference(new TogglePreference(context, "Enable debug log", "Show extension debug log.", diff --git a/patches/src/main/resources/addresources/values/strings.xml b/patches/src/main/resources/addresources/values/strings.xml index 86fb2405cc..c8bee767d8 100644 --- a/patches/src/main/resources/addresources/values/strings.xml +++ b/patches/src/main/resources/addresources/values/strings.xml @@ -60,7 +60,8 @@ This is because Crowdin requires temporarily flattening this file and removing t Note This version is a pre-release and you may experience unexpected issues Official links - Donate + From d920e544110c814f0412cb1898a25240246cc0b4 Mon Sep 17 00:00:00 2001 From: LisoUseInAIKyrios <118716522+LisoUseInAIKyrios@users.noreply.github.com> Date: Wed, 27 Nov 2024 16:33:32 +0400 Subject: [PATCH 2/5] fix: Use "Miscellaneous" category name instead of "Extension" --- .../preference/categories/ExtensionPreferenceCategory.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/extensions/shared/src/main/java/app/revanced/extension/tiktok/settings/preference/categories/ExtensionPreferenceCategory.java b/extensions/shared/src/main/java/app/revanced/extension/tiktok/settings/preference/categories/ExtensionPreferenceCategory.java index d98217c03e..60d7983ea0 100644 --- a/extensions/shared/src/main/java/app/revanced/extension/tiktok/settings/preference/categories/ExtensionPreferenceCategory.java +++ b/extensions/shared/src/main/java/app/revanced/extension/tiktok/settings/preference/categories/ExtensionPreferenceCategory.java @@ -11,7 +11,7 @@ public class ExtensionPreferenceCategory extends ConditionalPreferenceCategory { public ExtensionPreferenceCategory(Context context, PreferenceScreen screen) { super(context, screen); - setTitle("Extension"); + setTitle("Miscellaneous"); } @Override From 04510a98d149819658e7562aae1512f34627442b Mon Sep 17 00:00:00 2001 From: LisoUseInAIKyrios <118716522+LisoUseInAIKyrios@users.noreply.github.com> Date: Wed, 27 Nov 2024 16:44:04 +0400 Subject: [PATCH 3/5] fix: adjust delay --- .../settings/preference/ReVancedAboutPreference.java | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/extensions/shared/src/main/java/app/revanced/extension/shared/settings/preference/ReVancedAboutPreference.java b/extensions/shared/src/main/java/app/revanced/extension/shared/settings/preference/ReVancedAboutPreference.java index dd1ba34173..67be14a869 100644 --- a/extensions/shared/src/main/java/app/revanced/extension/shared/settings/preference/ReVancedAboutPreference.java +++ b/extensions/shared/src/main/java/app/revanced/extension/shared/settings/preference/ReVancedAboutPreference.java @@ -101,7 +101,7 @@ private String createDialogHtml(WebLink[] aboutLinks) { builder.append(""); + + "src=\"").append(AboutLinksRoutes.aboutLogoUrl).append("\" />"); } String patchesVersion = Utils.getPatchesReleaseVersion(); @@ -148,9 +148,8 @@ private String createDialogHtml(WebLink[] aboutLinks) { setOnPreferenceClickListener(pref -> { // Show a progress spinner if the social links are not fetched yet. if (!AboutLinksRoutes.hasFetchedLinks() && Utils.isNetworkConnected()) { - // Show a progress spinner, but only if the api fetch - // takes more than a quarter of a second. - final long delayToShowProgressSpinner = 250; + // Show a progress spinner, but only if the api fetch takes more than a half a second. + final long delayToShowProgressSpinner = 500; ProgressDialog progress = new ProgressDialog(getContext()); progress.setProgressStyle(ProgressDialog.STYLE_SPINNER); From 5503c12d101a1cd8a4cbc08b39fad9bec6d498bf Mon Sep 17 00:00:00 2001 From: LisoUseInAIKyrios <118716522+LisoUseInAIKyrios@users.noreply.github.com> Date: Wed, 27 Nov 2024 17:13:52 +0400 Subject: [PATCH 4/5] fix typo --- .../settings/preference/ReVancedTikTokAboutPreference.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/extensions/shared/src/main/java/app/revanced/extension/tiktok/settings/preference/ReVancedTikTokAboutPreference.java b/extensions/shared/src/main/java/app/revanced/extension/tiktok/settings/preference/ReVancedTikTokAboutPreference.java index 624c2a45fa..f20a0b6350 100644 --- a/extensions/shared/src/main/java/app/revanced/extension/tiktok/settings/preference/ReVancedTikTokAboutPreference.java +++ b/extensions/shared/src/main/java/app/revanced/extension/tiktok/settings/preference/ReVancedTikTokAboutPreference.java @@ -26,7 +26,7 @@ public class ReVancedTikTokAboutPreference extends ReVancedAboutPreference { { //noinspection deprecation - setTitle("Donate"); + setTitle("About"); } public ReVancedTikTokAboutPreference(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes) { From 6ad7f024ad9c395e12ec7af6b4641e73dc89d5ee Mon Sep 17 00:00:00 2001 From: LisoUseInAIKyrios <118716522+LisoUseInAIKyrios@users.noreply.github.com> Date: Wed, 27 Nov 2024 17:22:32 +0400 Subject: [PATCH 5/5] cleanup --- .../settings/preference/ReVancedAboutPreference.java | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/extensions/shared/src/main/java/app/revanced/extension/shared/settings/preference/ReVancedAboutPreference.java b/extensions/shared/src/main/java/app/revanced/extension/shared/settings/preference/ReVancedAboutPreference.java index 67be14a869..c3db3b4b08 100644 --- a/extensions/shared/src/main/java/app/revanced/extension/shared/settings/preference/ReVancedAboutPreference.java +++ b/extensions/shared/src/main/java/app/revanced/extension/shared/settings/preference/ReVancedAboutPreference.java @@ -177,12 +177,8 @@ private void fetchLinksAndShowDialog(@Nullable Handler handler, // Enable to randomly force a delay to debug the spinner logic. final boolean debugSpinnerDelayLogic = false; //noinspection ConstantConditions - if (debugSpinnerDelayLogic && handler != null) { - try { - if (Math.random() < 0.5f) Thread.sleep((long) (Math.random() * 4000)); - } catch (InterruptedException e) { - throw new RuntimeException(e); - } + if (debugSpinnerDelayLogic && handler != null && Math.random() < 0.5f) { + Utils.doNothingForDuration((long) (Math.random() * 4000)); } Utils.runOnMainThreadNowOrLater(() -> {