change default user agent

jmir1 · jmir1 · commit dc8d1afb3772 · 2022-08-26T01:12:18.000+02:00
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -3,7 +3,7 @@
 I acknowledge that:
 
 - I have updated:
-  - To the latest version of the app (stable is v0.12.3.7)
+  - To the latest version of the app (stable is v0.12.3.8)
   - All extensions
 - If this is an issue with an anime extension, that I should be opening an issue in https://github.com/jmir1/aniyomi-extensions
 - I have searched the existing issues and this is new ticket **NOT** a duplicate or related to another open issue
diff --git a/.github/ISSUE_TEMPLATE/report_issue.yml b/.github/ISSUE_TEMPLATE/report_issue.yml
@@ -52,7 +52,7 @@ body:
       label: Aniyomi version
       description: You can find your Aniyomi version in **More → About**.
       placeholder: |
-        Example: "0.12.3.7"
+        Example: "0.12.3.8"
     validations:
       required: true
 
@@ -97,7 +97,7 @@ body:
           required: true
         - label: I have tried the [troubleshooting guide](https://aniyomi.jmir.xyz/help/guides/troubleshooting/).
           required: true
-        - label: I have updated the app to version **[0.12.3.7](https://github.com/jmir1/aniyomi/releases/latest)**.
+        - label: I have updated the app to version **[0.12.3.8](https://github.com/jmir1/aniyomi/releases/latest)**.
           required: true
         - label: I have updated all installed extensions.
           required: true
diff --git a/.github/ISSUE_TEMPLATE/request_feature.yml b/.github/ISSUE_TEMPLATE/request_feature.yml
@@ -32,7 +32,7 @@ body:
           required: true
         - label: If this is an issue with an extension, I should be opening an issue in the [extensions repository](https://github.com/jmir1/aniyomi-extensions/issues/new/choose).
           required: true
-        - label: I have updated the app to version **[0.12.3.7](https://github.com/jmir1/aniyomi/releases/latest)**.
+        - label: I have updated the app to version **[0.12.3.8](https://github.com/jmir1/aniyomi/releases/latest)**.
           required: true
         - label: I will fill out all of the requested information in this form.
           required: true
diff --git a/app/build.gradle.kts b/app/build.gradle.kts
@@ -30,7 +30,7 @@ android {
         minSdk = AndroidConfig.minSdk
         targetSdk = AndroidConfig.targetSdk
         versionCode = 72
-        versionName = "0.12.3.7"
+        versionName = "0.12.3.8"
 
         buildConfigField("String", "COMMIT_COUNT", "\"${getCommitCount()}\"")
         buildConfigField("String", "COMMIT_SHA", "\"${getGitSha()}\"")
diff --git a/app/src/main/java/eu/kanade/tachiyomi/animesource/online/AnimeHttpSource.kt b/app/src/main/java/eu/kanade/tachiyomi/animesource/online/AnimeHttpSource.kt
@@ -74,7 +74,7 @@ abstract class AnimeHttpSource : AnimeCatalogueSource {
      * Headers builder for requests. Implementations can override this method for custom headers.
      */
     protected open fun headersBuilder() = Headers.Builder().apply {
-        add("User-Agent", DEFAULT_USER_AGENT)
+        add("User-Agent", network.defaultUserAgent)
     }
 
     /**
@@ -380,8 +380,4 @@ abstract class AnimeHttpSource : AnimeCatalogueSource {
      * Returns the list of filters for the source.
      */
     override fun getFilterList() = AnimeFilterList()
-
-    companion object {
-        const val DEFAULT_USER_AGENT = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.5005.124 Safari/537.36 Edg/102.0.1245.44"
-    }
 }
diff --git a/app/src/main/java/eu/kanade/tachiyomi/data/preference/PreferenceKeys.kt b/app/src/main/java/eu/kanade/tachiyomi/data/preference/PreferenceKeys.kt
@@ -47,6 +47,8 @@ object PreferenceKeys {
 
     const val removeAfterMarkedAsRead = "pref_remove_after_marked_as_read_key"
 
+    const val defaultUserAgent = "default_user_agent"
+
     const val removeBookmarkedChapters = "pref_remove_bookmarked"
 
     const val filterDownloaded = "pref_filter_library_downloaded"
diff --git a/app/src/main/java/eu/kanade/tachiyomi/data/preference/PreferencesHelper.kt b/app/src/main/java/eu/kanade/tachiyomi/data/preference/PreferencesHelper.kt
@@ -254,6 +254,8 @@ class PreferencesHelper(val context: Context) {
 
     fun libraryUpdateInterval() = flowPrefs.getInt("pref_library_update_interval_key", 24)
 
+    fun defaultUserAgent() = flowPrefs.getString(Keys.defaultUserAgent, "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:103.0) Gecko/20100101 Firefox/103.0")
+
     fun libraryUpdateDeviceRestriction() = flowPrefs.getStringSet("library_update_restriction", setOf(DEVICE_ONLY_ON_WIFI))
     fun libraryUpdateMangaRestriction() = flowPrefs.getStringSet("library_update_manga_restriction", setOf(MANGA_FULLY_READ, MANGA_ONGOING))
 
diff --git a/app/src/main/java/eu/kanade/tachiyomi/network/NetworkHelper.kt b/app/src/main/java/eu/kanade/tachiyomi/network/NetworkHelper.kt
@@ -55,4 +55,8 @@ class NetworkHelper(context: Context) {
             .addInterceptor(CloudflareInterceptor(context))
             .build()
     }
+
+    val defaultUserAgent by lazy {
+        preferences.defaultUserAgent().get()
+    }
 }
diff --git a/app/src/main/java/eu/kanade/tachiyomi/network/interceptor/CloudflareInterceptor.kt b/app/src/main/java/eu/kanade/tachiyomi/network/interceptor/CloudflareInterceptor.kt
@@ -9,7 +9,6 @@ import android.widget.Toast
 import androidx.core.content.ContextCompat
 import eu.kanade.tachiyomi.R
 import eu.kanade.tachiyomi.network.NetworkHelper
-import eu.kanade.tachiyomi.source.online.HttpSource
 import eu.kanade.tachiyomi.util.lang.launchUI
 import eu.kanade.tachiyomi.util.system.DeviceUtil
 import eu.kanade.tachiyomi.util.system.WebViewClientCompat
@@ -110,7 +109,7 @@ class CloudflareInterceptor(private val context: Context) : Interceptor {
 
             // Avoid sending empty User-Agent, Chromium WebView will reset to default if empty
             webview.settings.userAgentString = request.header("User-Agent")
-                ?: HttpSource.DEFAULT_USER_AGENT
+                ?: networkHelper.defaultUserAgent
 
             webview.webViewClient = object : WebViewClientCompat() {
                 override fun onPageFinished(view: WebView, url: String) {
diff --git a/app/src/main/java/eu/kanade/tachiyomi/network/interceptor/UserAgentInterceptor.kt b/app/src/main/java/eu/kanade/tachiyomi/network/interceptor/UserAgentInterceptor.kt
@@ -1,18 +1,22 @@
 package eu.kanade.tachiyomi.network.interceptor
 
-import eu.kanade.tachiyomi.source.online.HttpSource
+import eu.kanade.tachiyomi.network.NetworkHelper
 import okhttp3.Interceptor
 import okhttp3.Response
+import uy.kohesive.injekt.injectLazy
 
 class UserAgentInterceptor : Interceptor {
+
+    private val networkHelper: NetworkHelper by injectLazy()
+
     override fun intercept(chain: Interceptor.Chain): Response {
         val originalRequest = chain.request()
 
         return if (originalRequest.header("User-Agent").isNullOrEmpty()) {
             val newRequest = originalRequest
                 .newBuilder()
                 .removeHeader("User-Agent")
-                .addHeader("User-Agent", HttpSource.DEFAULT_USER_AGENT)
+                .addHeader("User-Agent", networkHelper.defaultUserAgent)
                 .build()
             chain.proceed(newRequest)
         } else {
diff --git a/app/src/main/java/eu/kanade/tachiyomi/source/online/HttpSource.kt b/app/src/main/java/eu/kanade/tachiyomi/source/online/HttpSource.kt
@@ -74,7 +74,7 @@ abstract class HttpSource : CatalogueSource {
      * Headers builder for requests. Implementations can override this method for custom headers.
      */
     protected open fun headersBuilder() = Headers.Builder().apply {
-        add("User-Agent", DEFAULT_USER_AGENT)
+        add("User-Agent", network.defaultUserAgent)
     }
 
     /**
@@ -369,8 +369,4 @@ abstract class HttpSource : CatalogueSource {
      * Returns the list of filters for the source.
      */
     override fun getFilterList() = FilterList()
-
-    companion object {
-        const val DEFAULT_USER_AGENT = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.5005.124 Safari/537.36 Edg/102.0.1245.44"
-    }
 }
diff --git a/app/src/main/java/eu/kanade/tachiyomi/ui/setting/SettingsAdvancedController.kt b/app/src/main/java/eu/kanade/tachiyomi/ui/setting/SettingsAdvancedController.kt
@@ -29,6 +29,7 @@ import eu.kanade.tachiyomi.util.lang.launchIO
 import eu.kanade.tachiyomi.util.lang.withUIContext
 import eu.kanade.tachiyomi.util.preference.bindTo
 import eu.kanade.tachiyomi.util.preference.defaultValue
+import eu.kanade.tachiyomi.util.preference.editTextPreference
 import eu.kanade.tachiyomi.util.preference.entriesRes
 import eu.kanade.tachiyomi.util.preference.intListPreference
 import eu.kanade.tachiyomi.util.preference.listPreference
@@ -187,6 +188,36 @@ class SettingsAdvancedController : SettingsController() {
                     true
                 }
             }
+
+            editTextPreference {
+                key = Keys.defaultUserAgent
+                titleRes = R.string.pref_user_agent_string
+                text = preferences.defaultUserAgent().get()
+                summary = network.defaultUserAgent
+
+                onChange {
+                    if (it.toString().isBlank()) {
+                        activity?.toast(R.string.error_user_agent_string_blank)
+                        false
+                    } else {
+                        activity?.toast(R.string.requires_app_restart)
+                        true
+                    }
+                }
+            }
+            if (preferences.defaultUserAgent().isSet()) {
+                preference {
+                    key = "pref_reset_user_agent"
+                    titleRes = R.string.pref_reset_user_agent_string
+
+                    visibleIf(preferences.defaultUserAgent()) { it != preferences.defaultUserAgent().defaultValue }
+
+                    onClick {
+                        preferences.defaultUserAgent().delete()
+                        activity?.toast(R.string.requires_app_restart)
+                    }
+                }
+            }
         }
 
         preferenceCategory {
diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml
@@ -556,6 +556,9 @@
     <string name="pref_tablet_ui_mode">Tablet UI</string>
     <string name="pref_verbose_logging">Verbose logging</string>
     <string name="pref_verbose_logging_summary">Print verbose logs to system log (reduces app performance)</string>
+    <string name="pref_user_agent_string">Default user agent string</string>
+    <string name="pref_reset_user_agent_string">Reset default user agent string</string>
+    <string name="error_user_agent_string_blank">User agent string can not be blank</string>
 
       <!-- About section -->
     <string name="website">Website</string>

Original file line number	Diff line number	Diff line change
`@@ -55,4 +55,8 @@ class NetworkHelper(context: Context) {`
`55`	`55`	`.addInterceptor(CloudflareInterceptor(context))`
`56`	`56`	`.build()`
`57`	`57`	`}`
	`58`	`+`
	`59`	`+ val defaultUserAgent by lazy {`
	`60`	`+ preferences.defaultUserAgent().get()`
	`61`	`+ }`
`58`	`62`	`}`