From 7ee44f1fe592e716ea314bac3ea428b917008d2b Mon Sep 17 00:00:00 2001
From: MajorTanya <39014446+MajorTanya@users.noreply.github.com>
Date: Wed, 30 Oct 2024 20:52:18 +0100
Subject: [PATCH] feat(tracker): Some improvements to Bangumi tracker search
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

In short:
- fetch & show actual summary
- fallback to "name" if "name_cn" is empty
- request larger responseGroup to get & display the summary & rating
- add type filter query param to make Bangumi filter, not us

Previously, we only displayed the "name" in the summary area and used
"name_cn" as the entry name. However, "name_cn" (Chinese name) can be
an empty string at times, resulting in an awkward looking search
result list where some, many, or even all the results have no title
displayed and only show the "name" (Japanese name) in the summary
area. This has been solved by using "name" as a fallback value should
"name_cn" be empty.

If a Chinese name is available, the original name is prepended to the
summary with the addition "作品原名：" (meaning "original series title").

By using the "responseGroup=large" query parameter, we can request
the required data we need to display the actual summary for an entry
and the entry's average rating.
The "name" is prepended to the summary contents, if any exist, so it
is still accessible for series identification if a "name_cn" exists
too and was used for the result title.

Adding the "type=1" filter query parameter means Bangumi will only
return entries of type 1 ("book") instead of all types and Mihon
needing to filter, resulting in potentially missed entry matches.
---
 CHANGELOG.md                                          |  1 +
 .../kanade/tachiyomi/data/track/bangumi/BangumiApi.kt |  3 ++-
 .../tachiyomi/data/track/bangumi/dto/BGMSearch.kt     | 11 ++++++++---
 3 files changed, 11 insertions(+), 4 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 6d42ca5f4a..a15f611a63 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -21,6 +21,7 @@ The format is simplified version of [Keep a Changelog](https://keepachangelog.co
 - Minor visual adjustments
 - Tell user to restart the app when User-Agent is changed (@NGB-Was-Taken)
 - Re-enable fetching licensed manga (@Animeboynz)
+- Bangumi search now shows the score and summary of a search result (@MajorTanya)
 
 ### Fixes
 - Fixed only few DoH provider is actually being used (Cloudflare, Google, AdGuard, and Quad9)
diff --git a/app/src/main/java/eu/kanade/tachiyomi/data/track/bangumi/BangumiApi.kt b/app/src/main/java/eu/kanade/tachiyomi/data/track/bangumi/BangumiApi.kt
index 259ca3a2dd..8bf1019985 100644
--- a/app/src/main/java/eu/kanade/tachiyomi/data/track/bangumi/BangumiApi.kt
+++ b/app/src/main/java/eu/kanade/tachiyomi/data/track/bangumi/BangumiApi.kt
@@ -71,6 +71,8 @@ class BangumiApi(
             val url = "$API_URL/search/subject/${URLEncoder.encode(search, StandardCharsets.UTF_8.name())}"
                 .toUri()
                 .buildUpon()
+                .appendQueryParameter("type", "1")
+                .appendQueryParameter("responseGroup", "large")
                 .appendQueryParameter("max_results", "20")
                 .build()
             with(json) {
@@ -81,7 +83,6 @@ class BangumiApi(
                         if (result.code == 404) emptyList<TrackSearch>()
 
                         result.list
-                            ?.filter { it.type == 1 }
                             ?.map { it.toTrackSearch(trackId) }
                             .orEmpty()
                     }
diff --git a/app/src/main/java/eu/kanade/tachiyomi/data/track/bangumi/dto/BGMSearch.kt b/app/src/main/java/eu/kanade/tachiyomi/data/track/bangumi/dto/BGMSearch.kt
index e940755b0f..ece8f5e983 100644
--- a/app/src/main/java/eu/kanade/tachiyomi/data/track/bangumi/dto/BGMSearch.kt
+++ b/app/src/main/java/eu/kanade/tachiyomi/data/track/bangumi/dto/BGMSearch.kt
@@ -17,6 +17,7 @@ data class BGMSearchItem(
     val nameCn: String,
     val name: String,
     val type: Int,
+    val summary: String?,
     val images: BGMSearchItemCovers?,
     @SerialName("eps_count")
     val epsCount: Long?,
@@ -25,9 +26,13 @@ data class BGMSearchItem(
 ) {
     fun toTrackSearch(trackId: Long): TrackSearch = TrackSearch.create(trackId).apply {
         media_id = this@BGMSearchItem.id
-        title = nameCn
-        cover_url = images?.common ?: ""
-        summary = this@BGMSearchItem.name
+        title = nameCn.ifBlank { name }
+        cover_url = images?.common.orEmpty()
+        summary = if (nameCn.isNotBlank()) {
+            "作品原名：$name" + this@BGMSearchItem.summary?.let { "\n$it" }.orEmpty()
+        } else {
+            this@BGMSearchItem.summary.orEmpty()
+        }
         score = rating?.score?.toFloat() ?: -1.0F
         tracking_url = url
         total_chapters = epsCount ?: 0