Proof of concept implementation for a Steam metadata provider plugin

Mainly for testing purposes
2026-06-14 08:15:27 +00:00 · 2024-11-01 15:41:25 +01:00
parent 34f00c091f
commit cebfc99ec2
17 changed files with 327 additions and 29 deletions
@@ -0,0 +1,138 @@
+package de.grimsi.gameyfin.plugins.steam
+
+import de.grimsi.gameyfin.pluginapi.core.GameyfinPlugin
+import de.grimsi.gameyfin.pluginapi.core.PluginConfigElement
+import de.grimsi.gameyfin.pluginapi.gamemetadata.GameMetadata
+import de.grimsi.gameyfin.pluginapi.gamemetadata.GameMetadataProvider
+import io.ktor.client.HttpClient
+import io.ktor.client.call.body
+import io.ktor.client.engine.cio.CIO
+import io.ktor.client.plugins.contentnegotiation.ContentNegotiation
+import io.ktor.client.request.get
+import io.ktor.serialization.kotlinx.json.json
+import kotlinx.coroutines.runBlocking
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.json.JsonObject
+import kotlinx.serialization.json.boolean
+import kotlinx.serialization.json.jsonArray
+import kotlinx.serialization.json.jsonObject
+import kotlinx.serialization.json.jsonPrimitive
+import me.xdrop.fuzzywuzzy.FuzzySearch
+import org.pf4j.Extension
+import org.pf4j.PluginWrapper
+import java.net.URLEncoder
+import java.nio.charset.StandardCharsets
+import java.time.Instant
+import java.time.LocalDate
+import java.time.ZoneOffset
+import java.time.format.DateTimeFormatter
+import java.util.Locale
+
+@Serializable
+data class SteamSearchResult(
+    val total: Int,
+    val items: List<SteamGame>
+)
+
+@Serializable
+data class SteamGame(
+    val type: String,
+    val name: String,
+    val id: Int,
+    val price: Price?,
+    val tiny_image: String,
+    val metascore: String?,
+    val platforms: Platforms,
+    val streamingvideo: Boolean,
+    val controller_support: String
+)
+
+@Serializable
+data class Price(
+    val currency: String,
+    val initial: Int,
+    val final: Int
+)
+
+@Serializable
+data class Platforms(
+    val windows: Boolean,
+    val mac: Boolean,
+    val linux: Boolean
+)
+
+class SteamPlugin(wrapper: PluginWrapper) : GameyfinPlugin(wrapper) {
+    override val configMetadata: List<PluginConfigElement> = emptyList()
+
+    @Extension
+    class SteamMetadataProvider : GameMetadataProvider {
+        val client = HttpClient(CIO) {
+            install(ContentNegotiation) {
+                json()
+            }
+        }
+
+        override fun fetchMetadata(gameId: String): GameMetadata? {
+            val searchResult: List<SteamGame> = runBlocking { searchStore(gameId) }
+            if (searchResult.isEmpty()) return null
+
+            val bestMatchingTitle = FuzzySearch.extractOne(gameId, searchResult.map { it.name }).string
+            val bestMatch = searchResult.find { it.name == bestMatchingTitle } ?: return null
+
+            return runBlocking { getGameDetails(bestMatch.id) }
+        }
+
+        private suspend fun searchStore(title: String): List<SteamGame> {
+            val encodedTitle = URLEncoder.encode(title, StandardCharsets.UTF_8.toString())
+            val url = "https://store.steampowered.com/api/storesearch?term=$encodedTitle&cc=en"
+            return try {
+                val searchResult: SteamSearchResult = client.get(url).body()
+                searchResult.items
+            } catch (e: Exception) {
+                println(e.message)
+                emptyList()
+            }
+        }
+
+        private suspend fun getGameDetails(id: Int): GameMetadata? {
+            val url = "https://store.steampowered.com/api/appdetails?appids=$id"
+            val response: JsonObject = (client.get(url).body() as JsonObject)[id.toString()]?.jsonObject ?: return null
+
+            if (response["success"]?.jsonPrimitive?.boolean == false) return null
+
+            val game = response["data"]?.jsonObject ?: return null
+
+            val metadata = GameMetadata(
+                title = string(game, "name"),
+                description = string(game, "detailed_description"),
+                release = date(game["release_date"]?.jsonObject["date"]?.jsonPrimitive?.content!!),
+                userRating = 0,
+                criticRating = 0,
+                developedBy = stringList(game, "developers"),
+                publishedBy = stringList(game, "publishers"),
+                genres = emptyList(),
+                themes = emptyList(),
+                screenshotUrls = emptyList(),
+                videoUrls = emptyList(),
+                features = emptyList(),
+                perspectives = emptyList()
+            )
+
+            return metadata
+        }
+
+        private fun string(json: JsonObject, key: String): String {
+            return json[key]?.jsonPrimitive?.content ?: ""
+        }
+
+        private fun stringList(json: JsonObject, key: String): List<String> {
+            return json[key]?.jsonArray?.map { it.jsonPrimitive.content } ?: emptyList()
+        }
+
+        fun date(dateString: String): Instant {
+            val formatter = DateTimeFormatter.ofPattern("dd MMM, yyyy", Locale.ENGLISH)
+            val localDate = LocalDate.parse(dateString, formatter)
+            return localDate.atStartOfDay().toInstant(ZoneOffset.UTC)
+        }
+    }
+}
@@ -0,0 +1,6 @@
+Manifest-Version: 1.0
+Plugin-Class: de.grimsi.gameyfin.plugins.steam.SteamPlugin
+Plugin-Id: steam
+Plugin-Description: Steam Metadata
+Plugin-Version: 1.0.0-alpha1
+Plugin-Provider: grimsi