diff --git a/app/src/main/java/com/github/damontecres/wholphin/data/model/ExternalRating.kt b/app/src/main/java/com/github/damontecres/wholphin/data/model/ExternalRating.kt new file mode 100644 index 0000000000..68fcfadf96 --- /dev/null +++ b/app/src/main/java/com/github/damontecres/wholphin/data/model/ExternalRating.kt @@ -0,0 +1,112 @@ +package com.github.damontecres.wholphin.data.model + +import androidx.compose.runtime.Immutable +import java.util.Locale +import java.util.UUID + +/** + * A single rating from a third party source, such as from the MDBList Ratings server plugin + * + * @param source the source key used by the plugin, eg "imdb", "tomatoes", "popcorn" + * @param value the rating in the source's own scale, eg 7.3 for imdb (out of 10) or 95 for tomatoes (percent) + * @param score the rating normalized to 0-100 if available + * @param iconUrl URL to the source's icon on the server + */ +@Immutable +data class ExternalRating( + val source: String, + val value: Double, + val score: Int?, + val iconUrl: String? = null, +) { + /** + * The icon for this rating, or null if the source isn't known + */ + val icon: ExternalRatingIcon? get() = ExternalRatingIcon.forRating(this) + + /** + * Text to display for the rating, formatted for the source's scale + * + * Some sources, such as TMDB, use a percentage for movies & series, but out of 10 for episodes + */ + val displayText: String + get() = + if (source in ALWAYS_PERCENT_SOURCES || (source in PERCENT_SOURCES && value > 10.0)) { + "${value.toInt()}%" + } else if (value <= 10.0) { + String.format(Locale.getDefault(), "%.1f", value) + } else { + value.toInt().toString() + } + + companion object { + private val ALWAYS_PERCENT_SOURCES = setOf("tomatoes", "popcorn") + private val PERCENT_SOURCES = setOf("tmdb", "trakt") + } +} + +/** + * The [ExternalRating]s for a specific item + */ +@Immutable +data class ExternalRatings( + val itemId: UUID? = null, + val ratings: List = emptyList(), +) + +/** + * Icons served by the MDBList Ratings server plugin at `/Plugins/MdbListRatings/Assets/{fileName}` + * + * @param fileName the name of the asset file on the server + * @param aspectRatio width divided by height of the image + */ +enum class ExternalRatingIcon( + val fileName: String, + val aspectRatio: Float, +) { + IMDB("IMDb.png", 1.5f), + TMDB("TMDB.png", 1.38f), + TOMATOES_FRESH("Rotten_Tomatoes.png", 1f), + TOMATOES_ROTTEN("Rotten_Tomatoes_rotten.png", 1f), + POPCORN_FRESH("Rotten_Tomatoes_positive_audience.png", .76f), + POPCORN_ROTTEN("Rotten_Tomatoes_negative_audience.png", 1.32f), + METACRITIC("Metacritic.png", 1f), + METACRITIC_USER("mus2.png", 1f), + ROGER_EBERT("Roger_Ebert.png", 1f), + TRAKT("Trakt.png", 1f), + LETTERBOXD("letterboxd.png", 1f), + MYANIMELIST("mal.png", 1f), + ANILIST("anilist.png", 1f), + KINOPOISK("kinopoisk.png", 1f), + SIMKL("simkl.png", 1f), + TVMAZE("tvmaze.png", 3.16f), + ; + + companion object { + /** + * The fresh/rotten threshold matches the plugin's web UI + */ + private const val FRESH_THRESHOLD = 60 + + fun forRating(rating: ExternalRating): ExternalRatingIcon? { + val score = rating.score ?: rating.value.toInt() + return when (rating.source) { + "imdb" -> IMDB + "tmdb" -> TMDB + "tomatoes" -> if (score in 1.. if (score in 1.. METACRITIC + "metacriticuser" -> METACRITIC_USER + "rogerebert" -> ROGER_EBERT + "trakt" -> TRAKT + "letterboxd" -> LETTERBOXD + "myanimelist" -> MYANIMELIST + "anilist" -> ANILIST + "kinopoisk" -> KINOPOISK + "simkl" -> SIMKL + "tvmaze" -> TVMAZE + else -> null + } + } + } +} diff --git a/app/src/main/java/com/github/damontecres/wholphin/preferences/AppPreference.kt b/app/src/main/java/com/github/damontecres/wholphin/preferences/AppPreference.kt index 05dd6d27d3..cb283668aa 100644 --- a/app/src/main/java/com/github/damontecres/wholphin/preferences/AppPreference.kt +++ b/app/src/main/java/com/github/damontecres/wholphin/preferences/AppPreference.kt @@ -586,7 +586,10 @@ sealed interface AppPreference { AppMultiChoicePreference( title = R.string.display_toggles_title, summary = R.string.display_toggles_summary, - defaultValue = DisplayToggle.entries.filterNot { it == DisplayToggle.UNRECOGNIZED }, + defaultValue = + DisplayToggle.entries.filterNot { + it == DisplayToggle.UNRECOGNIZED || it == DisplayToggle.MDBLIST_RATINGS + }, allValues = DisplayToggle.entries.filterNot { it == DisplayToggle.UNRECOGNIZED }, displayValues = R.array.display_toggle_types, displayValuesSubtitles = R.array.display_toggle_types_subtitles, diff --git a/app/src/main/java/com/github/damontecres/wholphin/services/MdbListRatingsService.kt b/app/src/main/java/com/github/damontecres/wholphin/services/MdbListRatingsService.kt new file mode 100644 index 0000000000..a26f0ddd8b --- /dev/null +++ b/app/src/main/java/com/github/damontecres/wholphin/services/MdbListRatingsService.kt @@ -0,0 +1,194 @@ +package com.github.damontecres.wholphin.services + +import android.util.LruCache +import com.github.damontecres.wholphin.data.model.ExternalRating +import com.github.damontecres.wholphin.data.model.ExternalRatingIcon +import com.github.damontecres.wholphin.preferences.DisplayToggle +import com.github.damontecres.wholphin.services.hilt.AuthOkHttpClient +import com.github.damontecres.wholphin.util.WholphinDispatchers +import kotlinx.coroutines.withContext +import kotlinx.serialization.ExperimentalSerializationApi +import kotlinx.serialization.Serializable +import kotlinx.serialization.json.Json +import kotlinx.serialization.json.decodeFromStream +import okhttp3.HttpUrl.Companion.toHttpUrlOrNull +import okhttp3.OkHttpClient +import okhttp3.Request +import org.jellyfin.sdk.api.client.ApiClient +import timber.log.Timber +import java.util.UUID +import java.util.concurrent.ConcurrentHashMap +import javax.inject.Inject +import javax.inject.Singleton +import kotlin.math.roundToInt + +/** + * Fetches ratings from the third party [MDBList Ratings](https://github.com/Druidblack/Jellyfin.Plugin.MDBList_Ratings) + * server plugin, if it is installed + * + * The plugin caches all ratings from MDBList on the server, so this is a single request per item. + * The server admin's choice of which ratings to show and in what order is respected. + */ +@Singleton +class MdbListRatingsService + @Inject + constructor( + @param:AuthOkHttpClient private val okHttpClient: OkHttpClient, + private val api: ApiClient, + private val userPreferencesService: UserPreferencesService, + ) { + private val json = + Json { + isLenient = true + ignoreUnknownKeys = true + } + + /** + * Settings per server base URL, an absent plugin is stored as [PluginSettings.NOT_INSTALLED] + */ + private val settingsCache = ConcurrentHashMap() + + private val ratingsCache = LruCache>(100) + + /** + * Get the ratings for an item + * + * @return the ratings to display, or an empty list if disabled, the plugin isn't installed, or there are no ratings + */ + suspend fun getRatings(itemId: UUID): List = + withContext(WholphinDispatchers.IO) { + val enabled = + DisplayToggle.MDBLIST_RATINGS in + userPreferencesService + .getCurrent() + .appPreferences.interfacePreferences.displayTogglesList + if (!enabled) return@withContext emptyList() + ratingsCache.get(itemId)?.let { return@withContext it } + try { + val settings = getSettings() ?: return@withContext emptyList() + if (!settings.installed) return@withContext emptyList() + val ratings = fetchRatings(itemId, settings) ?: return@withContext emptyList() + ratingsCache.put(itemId, ratings) + ratings + } catch (ex: Exception) { + Timber.w(ex, "Error fetching MDBList ratings for %s", itemId) + emptyList() + } + } + + private fun pluginUrl(path: String) = + api.baseUrl + ?.toHttpUrlOrNull() + ?.newBuilder() + ?.addPathSegments("Plugins/MdbListRatings") + ?.addPathSegments(path) + + /** + * URL to an icon served by the plugin + */ + private fun iconUrl(icon: ExternalRatingIcon): String? = pluginUrl("Assets")?.addPathSegment(icon.fileName)?.build()?.toString() + + @OptIn(ExperimentalSerializationApi::class) + private fun getSettings(): PluginSettings? { + val baseUrl = api.baseUrl ?: return null + settingsCache[baseUrl]?.let { return it } + val url = pluginUrl("WebClientSettings")?.build() ?: return null + val request = + Request + .Builder() + .url(url) + .get() + .build() + val settings = + okHttpClient.newCall(request).execute().use { res -> + if (res.isSuccessful) { + json.decodeFromStream(res.body.byteStream()) + } else if (res.code == 404) { + Timber.i("MDBList Ratings plugin is not installed") + PluginSettings.NOT_INSTALLED + } else { + // Don't cache other errors so it can be retried + Timber.w("Error fetching MDBList plugin settings: %s", res.code) + return null + } + } + settingsCache[baseUrl] = settings + return settings + } + + @OptIn(ExperimentalSerializationApi::class) + private fun fetchRatings( + itemId: UUID, + settings: PluginSettings, + ): List? { + val url = + pluginUrl("CachedByItemId") + ?.addQueryParameter("itemId", itemId.toString()) + ?.build() ?: return null + val request = + Request + .Builder() + .url(url) + .get() + .build() + val response = + okHttpClient.newCall(request).execute().use { res -> + if (!res.isSuccessful) { + Timber.w("Error fetching MDBList ratings for %s: %s", itemId, res.code) + return null + } + json.decodeFromStream(res.body.byteStream()) + } + val ratings = + response.ratings + .mapNotNull { rating -> + val value = rating.value?.takeIf { it > 0 } ?: return@mapNotNull null + val external = ExternalRating(source = rating.source, value = value, score = rating.score?.roundToInt()) + val icon = external.icon ?: return@mapNotNull null + external.copy(iconUrl = iconUrl(icon)) + } + return settings.order?.let { order -> + ratings + .filter { it.source in order } + .sortedBy { order.indexOf(it.source) } + } ?: ratings + } + + @Serializable + private data class PluginSettings( + val installed: Boolean = true, + val webAllRatingsMode: String = "all", + val webAllRatingsOrderCsv: String = "", + ) { + /** + * The sources to show in order, or null to show all of them + */ + val order: List? + get() = + if (webAllRatingsMode == "custom") { + webAllRatingsOrderCsv + .split(",") + .map { it.trim().lowercase() } + .filter { it.isNotBlank() } + .takeIf { it.isNotEmpty() } + } else { + null + } + + companion object { + val NOT_INSTALLED = PluginSettings(installed = false) + } + } + + @Serializable + private data class CachedRatingsResponse( + val ratings: List = emptyList(), + ) + + @Serializable + private data class CachedRating( + val source: String, + val value: Double? = null, + val score: Double? = null, + ) + } diff --git a/app/src/main/java/com/github/damontecres/wholphin/ui/components/QuickDetails.kt b/app/src/main/java/com/github/damontecres/wholphin/ui/components/QuickDetails.kt index 6db89c7574..9c08ba898e 100644 --- a/app/src/main/java/com/github/damontecres/wholphin/ui/components/QuickDetails.kt +++ b/app/src/main/java/com/github/damontecres/wholphin/ui/components/QuickDetails.kt @@ -1,7 +1,12 @@ package com.github.damontecres.wholphin.ui.components +import androidx.compose.foundation.layout.Arrangement +import androidx.compose.foundation.layout.Column +import androidx.compose.foundation.layout.ExperimentalLayoutApi +import androidx.compose.foundation.layout.FlowRow import androidx.compose.foundation.layout.Row import androidx.compose.foundation.layout.fillMaxSize +import androidx.compose.foundation.layout.size import androidx.compose.foundation.text.InlineTextContent import androidx.compose.material.icons.Icons import androidx.compose.material.icons.filled.Star @@ -9,9 +14,12 @@ import androidx.compose.runtime.Composable import androidx.compose.runtime.NonRestartableComposable import androidx.compose.runtime.getValue import androidx.compose.runtime.remember +import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier import androidx.compose.ui.graphics.Color +import androidx.compose.ui.layout.ContentScale import androidx.compose.ui.platform.LocalContext +import androidx.compose.ui.platform.LocalDensity import androidx.compose.ui.platform.LocalResources import androidx.compose.ui.res.painterResource import androidx.compose.ui.text.AnnotatedString @@ -19,10 +27,13 @@ import androidx.compose.ui.text.Placeholder import androidx.compose.ui.text.PlaceholderVerticalAlign import androidx.compose.ui.text.TextStyle import androidx.compose.ui.text.buildAnnotatedString +import androidx.compose.ui.unit.dp import androidx.tv.material3.Icon import androidx.tv.material3.MaterialTheme import androidx.tv.material3.Text +import coil3.compose.AsyncImage import com.github.damontecres.wholphin.R +import com.github.damontecres.wholphin.data.model.ExternalRating import com.github.damontecres.wholphin.data.model.QuickDetailsData import com.github.damontecres.wholphin.preferences.DisplayToggle import com.github.damontecres.wholphin.ui.dot @@ -39,6 +50,32 @@ fun QuickDetails( modifier: Modifier = Modifier, textStyle: TextStyle = MaterialTheme.typography.titleSmall, endsAt: DateTime? = null, + externalRatings: List = emptyList(), +) { + val enabled = LocalInterfaceCustomization.current.enabledDisplayToggles + val showExternalRatings = DisplayToggle.MDBLIST_RATINGS in enabled && externalRatings.isNotEmpty() + if (showExternalRatings) { + Column( + verticalArrangement = Arrangement.spacedBy(4.dp), + modifier = modifier, + ) { + // External ratings replace the critic & community ratings + QuickDetailsRow(details, timeRemaining, textStyle, endsAt, showRatings = false) + ExternalRatingsRow(externalRatings, MaterialTheme.typography.bodyMedium) + } + } else { + QuickDetailsRow(details, timeRemaining, textStyle, endsAt, showRatings = true, modifier = modifier) + } +} + +@Composable +private fun QuickDetailsRow( + details: QuickDetailsData?, + timeRemaining: Duration?, + textStyle: TextStyle, + endsAt: DateTime?, + showRatings: Boolean, + modifier: Modifier = Modifier, ) { val enabled = LocalInterfaceCustomization.current.enabledDisplayToggles val inlineContentMap = rememberQuickDetailsContentMap(textStyle) @@ -48,10 +85,10 @@ fun QuickDetails( if (DisplayToggle.OFFICIAL_RATING in enabled) { QuickDetailsText(details.officialRating, Modifier, textStyle, inlineContentMap) } - if (DisplayToggle.COMMUNITY_RATING in enabled) { + if (showRatings && DisplayToggle.COMMUNITY_RATING in enabled) { QuickDetailsText(details.communityRating, Modifier, textStyle, inlineContentMap) } - if (DisplayToggle.CRITIC_RATING in enabled) { + if (showRatings && DisplayToggle.CRITIC_RATING in enabled) { QuickDetailsText(details.criticRating, Modifier, textStyle, inlineContentMap) } } @@ -133,6 +170,45 @@ fun rememberQuickDetailsContentMap(textStyle: TextStyle = MaterialTheme.typograp ) } +/** + * Displays ratings from third party sources, each as an icon followed by its value + */ +@OptIn(ExperimentalLayoutApi::class) +@Composable +fun ExternalRatingsRow( + ratings: List, + textStyle: TextStyle, + modifier: Modifier = Modifier, +) { + val iconHeight = with(LocalDensity.current) { textStyle.fontSize.toDp() } + FlowRow( + horizontalArrangement = Arrangement.spacedBy(14.dp), + itemVerticalAlignment = Alignment.CenterVertically, + modifier = modifier, + ) { + ratings.forEach { rating -> + val icon = rating.icon ?: return@forEach + Row( + horizontalArrangement = Arrangement.spacedBy(5.dp), + verticalAlignment = Alignment.CenterVertically, + ) { + AsyncImage( + model = rating.iconUrl, + contentDescription = null, + contentScale = ContentScale.Fit, + modifier = Modifier.size(width = iconHeight * icon.aspectRatio, height = iconHeight), + ) + Text( + text = rating.displayText, + color = MaterialTheme.colorScheme.onSurface, + style = textStyle, + maxLines = 1, + ) + } + } + } +} + @Composable fun TimeRemaining( remaining: Duration, diff --git a/app/src/main/java/com/github/damontecres/wholphin/ui/detail/episode/EpisodeDetails.kt b/app/src/main/java/com/github/damontecres/wholphin/ui/detail/episode/EpisodeDetails.kt index b9956fb4ba..82a0294b43 100644 --- a/app/src/main/java/com/github/damontecres/wholphin/ui/detail/episode/EpisodeDetails.kt +++ b/app/src/main/java/com/github/damontecres/wholphin/ui/detail/episode/EpisodeDetails.kt @@ -28,6 +28,7 @@ import androidx.lifecycle.compose.LifecycleResumeEffect import com.github.damontecres.wholphin.R import com.github.damontecres.wholphin.data.ChosenStreams import com.github.damontecres.wholphin.data.model.BaseItem +import com.github.damontecres.wholphin.data.model.ExternalRating import com.github.damontecres.wholphin.preferences.UserPreferences import com.github.damontecres.wholphin.ui.RequestOrRestoreFocus import com.github.damontecres.wholphin.ui.components.ContextMenu @@ -136,6 +137,7 @@ fun EpisodeDetails( preferences = preferences, ep = ep, chosenStreams = state.chosenStreams, + externalRatings = state.externalRatings, playOnClick = { viewModel.navigateTo( Destination.Playback( @@ -220,6 +222,7 @@ fun EpisodeDetailsContent( preferences: UserPreferences, ep: BaseItem, chosenStreams: ChosenStreams?, + externalRatings: List, playOnClick: (Duration) -> Unit, overviewOnClick: () -> Unit, watchOnClick: () -> Unit, @@ -257,6 +260,7 @@ fun EpisodeDetailsContent( preferences = preferences, ep = ep, chosenStreams = chosenStreams, + externalRatings = externalRatings, bringIntoViewRequester = bringIntoViewRequester, overviewOnClick = overviewOnClick, modifier = diff --git a/app/src/main/java/com/github/damontecres/wholphin/ui/detail/episode/EpisodeDetailsHeader.kt b/app/src/main/java/com/github/damontecres/wholphin/ui/detail/episode/EpisodeDetailsHeader.kt index e8872180b3..72dfa25b46 100644 --- a/app/src/main/java/com/github/damontecres/wholphin/ui/detail/episode/EpisodeDetailsHeader.kt +++ b/app/src/main/java/com/github/damontecres/wholphin/ui/detail/episode/EpisodeDetailsHeader.kt @@ -22,6 +22,7 @@ import androidx.tv.material3.Text import com.github.damontecres.wholphin.R import com.github.damontecres.wholphin.data.ChosenStreams import com.github.damontecres.wholphin.data.model.BaseItem +import com.github.damontecres.wholphin.data.model.ExternalRating import com.github.damontecres.wholphin.preferences.UserPreferences import com.github.damontecres.wholphin.ui.components.EpisodeName import com.github.damontecres.wholphin.ui.components.OverviewText @@ -36,6 +37,7 @@ fun EpisodeDetailsHeader( preferences: UserPreferences, ep: BaseItem, chosenStreams: ChosenStreams?, + externalRatings: List, bringIntoViewRequester: BringIntoViewRequester, overviewOnClick: () -> Unit, modifier: Modifier = Modifier, @@ -55,7 +57,7 @@ fun EpisodeDetailsHeader( modifier = Modifier.fillMaxWidth(.60f), ) { val padding = 8.dp - QuickDetails(ep.ui.quickDetails, ep.timeRemainingOrRuntime) + QuickDetails(ep.ui.quickDetails, ep.timeRemainingOrRuntime, externalRatings = externalRatings) VideoStreamDetails( chosenStreams = chosenStreams, diff --git a/app/src/main/java/com/github/damontecres/wholphin/ui/detail/episode/EpisodeViewModel.kt b/app/src/main/java/com/github/damontecres/wholphin/ui/detail/episode/EpisodeViewModel.kt index 97aaaf8632..536edf358c 100644 --- a/app/src/main/java/com/github/damontecres/wholphin/ui/detail/episode/EpisodeViewModel.kt +++ b/app/src/main/java/com/github/damontecres/wholphin/ui/detail/episode/EpisodeViewModel.kt @@ -7,9 +7,11 @@ import com.github.damontecres.wholphin.data.ChosenStreams import com.github.damontecres.wholphin.data.ItemPlaybackRepository import com.github.damontecres.wholphin.data.ServerRepository import com.github.damontecres.wholphin.data.model.BaseItem +import com.github.damontecres.wholphin.data.model.ExternalRating import com.github.damontecres.wholphin.data.model.ItemPlayback import com.github.damontecres.wholphin.services.BackdropService import com.github.damontecres.wholphin.services.FavoriteWatchManager +import com.github.damontecres.wholphin.services.MdbListRatingsService import com.github.damontecres.wholphin.services.MediaManagementService import com.github.damontecres.wholphin.services.NavigationManager import com.github.damontecres.wholphin.services.ServerReportService @@ -58,6 +60,7 @@ class EpisodeViewModel private val userPreferencesService: UserPreferencesService, private val backdropService: BackdropService, private val mediaManagementService: MediaManagementService, + private val mdbListRatingsService: MdbListRatingsService, @Assisted val itemId: UUID, ) : ViewModel() { @AssistedFactory @@ -115,6 +118,8 @@ class EpisodeViewModel ) } backdropService.submit(item) + val externalRatings = mdbListRatingsService.getRatings(item.id) + _state.update { it.copy(externalRatings = externalRatings) } } catch (ex: CancellationException) { throw ex } catch (ex: Exception) { @@ -216,4 +221,5 @@ class EpisodeViewModel data class EpisodeState( val episode: DataLoadingState = DataLoadingState.Pending, val chosenStreams: ChosenStreams? = null, + val externalRatings: List = emptyList(), ) diff --git a/app/src/main/java/com/github/damontecres/wholphin/ui/detail/movie/MovieDetails.kt b/app/src/main/java/com/github/damontecres/wholphin/ui/detail/movie/MovieDetails.kt index ef0d186e5d..07e25f43c1 100644 --- a/app/src/main/java/com/github/damontecres/wholphin/ui/detail/movie/MovieDetails.kt +++ b/app/src/main/java/com/github/damontecres/wholphin/ui/detail/movie/MovieDetails.kt @@ -337,6 +337,7 @@ fun MovieDetailsContent( preferences = preferences, movie = movie, chosenStreams = state.chosenStreams, + externalRatings = state.externalRatings, bringIntoViewRequester = bringIntoViewRequester, overviewOnClick = overviewOnClick, modifier = diff --git a/app/src/main/java/com/github/damontecres/wholphin/ui/detail/movie/MovieDetailsHeader.kt b/app/src/main/java/com/github/damontecres/wholphin/ui/detail/movie/MovieDetailsHeader.kt index ee8f74f022..5d04ab8dda 100644 --- a/app/src/main/java/com/github/damontecres/wholphin/ui/detail/movie/MovieDetailsHeader.kt +++ b/app/src/main/java/com/github/damontecres/wholphin/ui/detail/movie/MovieDetailsHeader.kt @@ -20,6 +20,7 @@ import androidx.tv.material3.Text import com.github.damontecres.wholphin.R import com.github.damontecres.wholphin.data.ChosenStreams import com.github.damontecres.wholphin.data.model.BaseItem +import com.github.damontecres.wholphin.data.model.ExternalRating import com.github.damontecres.wholphin.preferences.UserPreferences import com.github.damontecres.wholphin.ui.components.GenreText import com.github.damontecres.wholphin.ui.components.HeaderUtils @@ -38,6 +39,7 @@ fun MovieDetailsHeader( preferences: UserPreferences, movie: BaseItem, chosenStreams: ChosenStreams?, + externalRatings: List, bringIntoViewRequester: BringIntoViewRequester, overviewOnClick: () -> Unit, modifier: Modifier = Modifier, @@ -67,6 +69,7 @@ fun MovieDetailsHeader( movie.ui.quickDetails, movie.timeRemainingOrRuntime, Modifier.padding(start = HeaderUtils.startPadding), + externalRatings = externalRatings, ) dto.genres?.letNotEmpty { diff --git a/app/src/main/java/com/github/damontecres/wholphin/ui/detail/movie/MovieViewModel.kt b/app/src/main/java/com/github/damontecres/wholphin/ui/detail/movie/MovieViewModel.kt index d0fea50677..603ec628e3 100644 --- a/app/src/main/java/com/github/damontecres/wholphin/ui/detail/movie/MovieViewModel.kt +++ b/app/src/main/java/com/github/damontecres/wholphin/ui/detail/movie/MovieViewModel.kt @@ -10,12 +10,14 @@ import com.github.damontecres.wholphin.data.ServerRepository import com.github.damontecres.wholphin.data.model.BaseItem import com.github.damontecres.wholphin.data.model.Chapter import com.github.damontecres.wholphin.data.model.DiscoverItem +import com.github.damontecres.wholphin.data.model.ExternalRating import com.github.damontecres.wholphin.data.model.ItemPlayback import com.github.damontecres.wholphin.data.model.Person import com.github.damontecres.wholphin.data.model.Trailer import com.github.damontecres.wholphin.services.BackdropService import com.github.damontecres.wholphin.services.ExtrasService import com.github.damontecres.wholphin.services.FavoriteWatchManager +import com.github.damontecres.wholphin.services.MdbListRatingsService import com.github.damontecres.wholphin.services.MediaManagementService import com.github.damontecres.wholphin.services.NavigationManager import com.github.damontecres.wholphin.services.PeopleFavorites @@ -71,6 +73,7 @@ class MovieViewModel private val userPreferencesService: UserPreferencesService, private val backdropService: BackdropService, private val mediaManagementService: MediaManagementService, + private val mdbListRatingsService: MdbListRatingsService, @Assisted val itemId: UUID, ) : ViewModel() { @AssistedFactory @@ -127,6 +130,10 @@ class MovieViewModel ) } backdropService.submit(movie) + viewModelScope.launchIO { + val externalRatings = mdbListRatingsService.getRatings(itemId) + _state.update { it.copy(externalRatings = externalRatings) } + } viewModelScope.launchIO { trailerService.getLocalTrailers(movie).letNotEmpty { localTrailers -> _state.update { @@ -302,6 +309,7 @@ data class MovieState( val discovered: List = emptyList(), val chosenStreams: ChosenStreams? = null, val canDelete: Boolean = false, + val externalRatings: List = emptyList(), ) { val movie: BaseItem? = (loading as? DataLoadingState.Success)?.data } diff --git a/app/src/main/java/com/github/damontecres/wholphin/ui/detail/series/FocusedEpisodeHeader.kt b/app/src/main/java/com/github/damontecres/wholphin/ui/detail/series/FocusedEpisodeHeader.kt index b63f1cbc6a..47bef6eb29 100644 --- a/app/src/main/java/com/github/damontecres/wholphin/ui/detail/series/FocusedEpisodeHeader.kt +++ b/app/src/main/java/com/github/damontecres/wholphin/ui/detail/series/FocusedEpisodeHeader.kt @@ -11,6 +11,7 @@ import androidx.compose.ui.platform.LocalContext import androidx.compose.ui.unit.dp import com.github.damontecres.wholphin.data.ChosenStreams import com.github.damontecres.wholphin.data.model.BaseItem +import com.github.damontecres.wholphin.data.model.ExternalRating import com.github.damontecres.wholphin.preferences.UserPreferences import com.github.damontecres.wholphin.ui.components.EpisodeName import com.github.damontecres.wholphin.ui.components.HeaderUtils @@ -23,6 +24,7 @@ fun FocusedEpisodeHeader( preferences: UserPreferences, ep: BaseItem?, chosenStreams: ChosenStreams?, + externalRatings: List, overviewOnClick: () -> Unit, overviewOnFocus: (FocusState) -> Unit, modifier: Modifier = Modifier, @@ -40,6 +42,7 @@ fun FocusedEpisodeHeader( it, ep.timeRemainingOrRuntime, Modifier.padding(start = HeaderUtils.startPadding), + externalRatings = externalRatings, ) } diff --git a/app/src/main/java/com/github/damontecres/wholphin/ui/detail/series/SeriesDetails.kt b/app/src/main/java/com/github/damontecres/wholphin/ui/detail/series/SeriesDetails.kt index f42961ad12..8dbe45680c 100644 --- a/app/src/main/java/com/github/damontecres/wholphin/ui/detail/series/SeriesDetails.kt +++ b/app/src/main/java/com/github/damontecres/wholphin/ui/detail/series/SeriesDetails.kt @@ -43,6 +43,7 @@ import com.github.damontecres.wholphin.R import com.github.damontecres.wholphin.data.ExtrasItem import com.github.damontecres.wholphin.data.model.BaseItem import com.github.damontecres.wholphin.data.model.DiscoverItem +import com.github.damontecres.wholphin.data.model.ExternalRating import com.github.damontecres.wholphin.data.model.Person import com.github.damontecres.wholphin.data.model.Trailer import com.github.damontecres.wholphin.data.model.studioNames @@ -191,6 +192,7 @@ fun SeriesDetails( extras = state.extras, people = state.people, similar = state.similar, + externalRatings = state.externalRatings, played = played, favorite = series.data.userData?.isFavorite ?: false, canDelete = state.canDeleteSeries, @@ -326,6 +328,7 @@ fun SeriesDetailsContent( series: BaseItem, seasons: List, similar: List, + externalRatings: List, trailers: List, extras: List, people: List, @@ -374,6 +377,7 @@ fun SeriesDetailsContent( item { SeriesDetailsHeader( series = series, + externalRatings = externalRatings, showLogo = preferences.appPreferences.interfacePreferences.showLogos, overviewOnClick = overviewOnClick, bringIntoViewRequester = bringIntoViewRequester, @@ -650,6 +654,7 @@ fun SeriesDetailsContent( @Composable fun SeriesDetailsHeader( series: BaseItem, + externalRatings: List, showLogo: Boolean, overviewOnClick: () -> Unit, bringIntoViewRequester: BringIntoViewRequester, @@ -677,6 +682,7 @@ fun SeriesDetailsHeader( series.ui.quickDetails, null, Modifier.padding(start = HeaderUtils.startPadding), + externalRatings = externalRatings, ) dto.studios?.let { val studios = remember { series.studioNames } diff --git a/app/src/main/java/com/github/damontecres/wholphin/ui/detail/series/SeriesOverview.kt b/app/src/main/java/com/github/damontecres/wholphin/ui/detail/series/SeriesOverview.kt index ccc8f49394..7b2a78105c 100644 --- a/app/src/main/java/com/github/damontecres/wholphin/ui/detail/series/SeriesOverview.kt +++ b/app/src/main/java/com/github/damontecres/wholphin/ui/detail/series/SeriesOverview.kt @@ -156,6 +156,7 @@ fun SeriesOverview( focusedEpisode?.let { viewModel.lookUpChosenTracks(it.id, it) viewModel.lookupPeopleInEpisode(it) + viewModel.lookUpEpisodeRatings(it) } } val chosenStreams = state.chosenStreams @@ -199,6 +200,7 @@ fun SeriesOverview( seasons = state.seasons, episodes = state.episodes, chosenStreams = chosenStreams, + episodeRatings = state.episodeRatings, peopleInEpisode = state.peopleInEpisode.people, seasonExtras = state.extras, position = position, diff --git a/app/src/main/java/com/github/damontecres/wholphin/ui/detail/series/SeriesOverviewContent.kt b/app/src/main/java/com/github/damontecres/wholphin/ui/detail/series/SeriesOverviewContent.kt index 0759572ccd..429e82dc74 100644 --- a/app/src/main/java/com/github/damontecres/wholphin/ui/detail/series/SeriesOverviewContent.kt +++ b/app/src/main/java/com/github/damontecres/wholphin/ui/detail/series/SeriesOverviewContent.kt @@ -47,6 +47,7 @@ import com.github.damontecres.wholphin.R import com.github.damontecres.wholphin.data.ChosenStreams import com.github.damontecres.wholphin.data.ExtrasItem import com.github.damontecres.wholphin.data.model.BaseItem +import com.github.damontecres.wholphin.data.model.ExternalRatings import com.github.damontecres.wholphin.data.model.Person import com.github.damontecres.wholphin.preferences.UserPreferences import com.github.damontecres.wholphin.ui.AspectRatios @@ -80,6 +81,7 @@ fun SeriesOverviewContent( episodes: EpisodeList, seasonExtras: List, chosenStreams: ChosenStreams?, + episodeRatings: ExternalRatings, peopleInEpisode: List, position: SeriesOverviewPosition, firstItemFocusRequester: FocusRequester, @@ -197,6 +199,8 @@ fun SeriesOverviewContent( preferences = preferences, ep = focusedEpisode, chosenStreams = chosenStreams, + externalRatings = + episodeRatings.ratings.takeIf { episodeRatings.itemId == focusedEpisode?.id }.orEmpty(), overviewOnClick = overviewOnClick, overviewOnFocus = { if (it.isFocused) { diff --git a/app/src/main/java/com/github/damontecres/wholphin/ui/detail/series/SeriesViewModel.kt b/app/src/main/java/com/github/damontecres/wholphin/ui/detail/series/SeriesViewModel.kt index 568cece8df..d3d958f668 100644 --- a/app/src/main/java/com/github/damontecres/wholphin/ui/detail/series/SeriesViewModel.kt +++ b/app/src/main/java/com/github/damontecres/wholphin/ui/detail/series/SeriesViewModel.kt @@ -10,6 +10,8 @@ import com.github.damontecres.wholphin.data.ItemPlaybackRepository import com.github.damontecres.wholphin.data.ServerRepository import com.github.damontecres.wholphin.data.model.BaseItem import com.github.damontecres.wholphin.data.model.DiscoverItem +import com.github.damontecres.wholphin.data.model.ExternalRating +import com.github.damontecres.wholphin.data.model.ExternalRatings import com.github.damontecres.wholphin.data.model.ItemPlayback import com.github.damontecres.wholphin.data.model.Person import com.github.damontecres.wholphin.data.model.Trailer @@ -17,6 +19,7 @@ import com.github.damontecres.wholphin.preferences.AppPreferences import com.github.damontecres.wholphin.services.BackdropService import com.github.damontecres.wholphin.services.ExtrasService import com.github.damontecres.wholphin.services.FavoriteWatchManager +import com.github.damontecres.wholphin.services.MdbListRatingsService import com.github.damontecres.wholphin.services.MediaManagementService import com.github.damontecres.wholphin.services.NavigationManager import com.github.damontecres.wholphin.services.PeopleFavorites @@ -101,6 +104,7 @@ class SeriesViewModel private val backdropService: BackdropService, private val seerrService: SeerrService, private val mediaManagementService: MediaManagementService, + private val mdbListRatingsService: MdbListRatingsService, @Assisted val seriesId: UUID, @Assisted val seasonEpisodeIds: SeasonEpisodeIds?, @Assisted val seriesPageType: SeriesPageType, @@ -142,6 +146,12 @@ class SeriesViewModel } } backdropService.submit(series) + if (seriesPageType == SeriesPageType.DETAILS) { + viewModelScope.launchIO { + val externalRatings = mdbListRatingsService.getRatings(seriesId) + _state.update { it.copy(externalRatings = externalRatings) } + } + } val seasonsDeferred = getSeasons(series, seasonEpisodeIds?.seasonNumber) @@ -537,6 +547,19 @@ class SeriesViewModel } private var chosenStreamsJob: Job? = null + private var episodeRatingsJob: Job? = null + + fun lookUpEpisodeRatings(item: BaseItem) { + episodeRatingsJob?.cancel() + if (state.value.episodeRatings.itemId != item.id) { + _state.update { it.copy(episodeRatings = ExternalRatings(item.id, emptyList())) } + } + episodeRatingsJob = + viewModelScope.launchIO { + val ratings = mdbListRatingsService.getRatings(item.id) + _state.update { it.copy(episodeRatings = ExternalRatings(item.id, ratings)) } + } + } fun lookUpChosenTracks( itemId: UUID, @@ -891,4 +914,6 @@ data class SeriesState( val discovered: List = emptyList(), val discoverSeries: DiscoverItem? = null, val chosenStreams: ChosenStreams? = null, + val externalRatings: List = emptyList(), + val episodeRatings: ExternalRatings = ExternalRatings(), ) diff --git a/app/src/main/proto/WholphinDataStore.proto b/app/src/main/proto/WholphinDataStore.proto index 6c184f2c27..cba5bd6b3e 100644 --- a/app/src/main/proto/WholphinDataStore.proto +++ b/app/src/main/proto/WholphinDataStore.proto @@ -193,6 +193,7 @@ enum DisplayToggle{ OFFICIAL_RATING = 0; CRITIC_RATING = 1; COMMUNITY_RATING = 2; + MDBLIST_RATINGS = 3; } message InterfacePreferences { diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml index 974b094a6a..b0ae93eedf 100644 --- a/app/src/main/res/values/strings.xml +++ b/app/src/main/res/values/strings.xml @@ -781,11 +781,13 @@ @string/official_rating @string/critic_rating @string/community_rating + @string/mdblist_ratings @string/tomatoes @string/stars + @string/mdblist_ratings_subtitle Search %s @@ -844,6 +846,8 @@ User interface language Ratings display Customize which to display + MDBList ratings + Replaces critic & community ratings on details pages. Requires the MDBList Ratings server plugin Profile protection Continue watching/Next up click behavior Play on click diff --git a/app/src/test/java/com/github/damontecres/wholphin/data/model/ExternalRatingTest.kt b/app/src/test/java/com/github/damontecres/wholphin/data/model/ExternalRatingTest.kt new file mode 100644 index 0000000000..9aabf6f7cf --- /dev/null +++ b/app/src/test/java/com/github/damontecres/wholphin/data/model/ExternalRatingTest.kt @@ -0,0 +1,50 @@ +package com.github.damontecres.wholphin.data.model + +import org.junit.Assert.assertEquals +import org.junit.Assert.assertNull +import org.junit.Test + +class ExternalRatingTest { + private fun rating( + source: String, + value: Double, + score: Int? = null, + ) = ExternalRating(source = source, value = value, score = score) + + @Test + fun formatsEachSourceInItsOwnScale() { + assertEquals("7.3", rating("imdb", 7.3).displayText) + assertEquals("95%", rating("tomatoes", 95.0).displayText) + assertEquals("77%", rating("popcorn", 77.0).displayText) + assertEquals("3.7", rating("letterboxd", 3.7).displayText) + assertEquals("78", rating("metacritic", 78.0).displayText) + } + + @Test + fun tmdbIsPercentForMoviesButOutOfTenForEpisodes() { + assertEquals("71%", rating("tmdb", 71.0).displayText) + assertEquals("8.3", rating("tmdb", 8.3).displayText) + assertEquals("75%", rating("trakt", 75.0).displayText) + assertEquals("8.0", rating("trakt", 8.0).displayText) + } + + @Test + fun tomatoesAreAlwaysPercent() { + assertEquals("5%", rating("tomatoes", 5.0).displayText) + } + + @Test + fun freshOrRottenIcons() { + assertEquals(ExternalRatingIcon.TOMATOES_FRESH, rating("tomatoes", 95.0, 95).icon) + assertEquals(ExternalRatingIcon.TOMATOES_FRESH, rating("tomatoes", 60.0, 60).icon) + assertEquals(ExternalRatingIcon.TOMATOES_ROTTEN, rating("tomatoes", 59.0, 59).icon) + assertEquals(ExternalRatingIcon.POPCORN_FRESH, rating("popcorn", 77.0, 77).icon) + assertEquals(ExternalRatingIcon.POPCORN_ROTTEN, rating("popcorn", 40.0, 40).icon) + } + + @Test + fun unknownSourceHasNoIcon() { + assertNull(rating("whatson_imdb", 7.7).icon) + assertNull(rating("mdblist", 83.0).icon) + } +}