Feat: Check file checksums if provided

Feat: Download mods to separate file and symlink them, allowing a separate user mods directory Fix: Handle mod updates correctly Fix: Replace provider for avatars
MineInAbyss · Mar 9, 2024 · b973bbd · b973bbd
1 parent 2f733b7
commit b973bbd
Show file tree

Hide file tree

Showing 39 changed files with 546 additions and 324 deletions.
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -1,4 +1,3 @@
-import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
 import de.undercouch.gradle.tasks.download.Download
 import org.apache.tools.ant.taskdefs.condition.Os
 import org.jetbrains.compose.desktop.application.dsl.TargetFormat
@@ -9,7 +8,6 @@ plugins {
     alias(idofrontLibs.plugins.kotlinx.serialization)
     alias(idofrontLibs.plugins.compose)
     id("de.undercouch.download") version "5.3.1"
-    id("com.github.johnrengelman.shadow") version "8.1.1"
 }
 
 repositories {

diff --git a/gradle.properties b/gradle.properties
@@ -1,3 +1,3 @@
 group=com.mineinabyss
-version=2.0.0-alpha.8
+version=2.0.0-alpha.9
 idofrontVersion=0.22.3
diff --git a/src/main/kotlin/com/mineinabyss/launchy/data/Typealiases.kt b/src/main/kotlin/com/mineinabyss/launchy/data/Typealiases.kt
@@ -4,3 +4,6 @@ typealias ModName = String
 typealias GroupName = String
 typealias DownloadURL = String
 typealias ConfigURL = String
+
+
+typealias ModID = String
diff --git a/src/main/kotlin/com/mineinabyss/launchy/data/config/GameInstance.kt b/src/main/kotlin/com/mineinabyss/launchy/data/config/GameInstance.kt
@@ -6,6 +6,7 @@ import androidx.compose.runtime.setValue
 import com.charleskorn.kaml.encodeToStream
 import com.mineinabyss.launchy.data.Dirs
 import com.mineinabyss.launchy.data.Formats
+import com.mineinabyss.launchy.logic.AppDispatchers
 import com.mineinabyss.launchy.logic.Downloader
 import com.mineinabyss.launchy.logic.UpdateResult
 import com.mineinabyss.launchy.logic.showDialogOnError
@@ -26,13 +27,12 @@ class GameInstance(
 
     val overridesDir = configDir / "overrides"
 
-    init {
-        require(configDir.isDirectory()) { "Game instance at $configDir must be a directory" }
-    }
-
-
     val minecraftDir = config.overrideMinecraftDir?.let { Path(it) } ?: Dirs.modpackDir(configDir.name)
 
+    val modsDir = (minecraftDir / "mods").createDirectories()
+    val userMods = (minecraftDir / "modsFromUser").createDirectories()
+
+    val downloadsDir: Path = minecraftDir / "launchyDownloads"
     val userConfigFile = (configDir / "config.yml")
 
     val updateCheckerScope = CoroutineScope(Dispatchers.IO)
@@ -43,17 +43,17 @@ class GameInstance(
     suspend fun createModpackState(state: LaunchyState): ModpackState? {
         val userConfig = ModpackUserConfig.load(userConfigFile).getOrNull() ?: ModpackUserConfig()
 
-        state.inProgressTasks["loadingModpack"] = InProgressTask("Loading modpack ${config.name}")
-        val modpack = config.source.loadInstance(this)
-            .showDialogOnError("Failed to read instance")
-            .getOrElse {
-                it.printStackTrace()
-                return null
-            }
-        state.inProgressTasks.remove("loadingModpack")
+        val modpack = state.runTask("loadingModpack ${config.name}", InProgressTask("Loading modpack ${config.name}")) {
+            config.source.loadInstance(this)
+                .showDialogOnError("Failed to read instance")
+                .getOrElse {
+                    it.printStackTrace()
+                    return null
+                }
+        }
 
         val cloudUrl = config.cloudInstanceURL
-        if (cloudUrl != null) state.ioScope.launch {
+        if (cloudUrl != null) AppDispatchers.IO.launch {
             val updates = Downloader.checkUpdates(cloudUrl)
             if (updates.result != UpdateResult.UpToDate) {
                 updatesAvailable = true
@@ -62,6 +62,11 @@ class GameInstance(
         return ModpackState(this, modpack, userConfig)
     }
 
+    init {
+        require(configDir.isDirectory()) { "Game instance at $configDir must be a directory" }
+        userMods
+    }
+
     companion object {
         fun create(state: LaunchyState, config: GameInstanceConfig) {
             val instanceDir = Dirs.modpackConfigDir(config.name)

diff --git a/src/main/kotlin/com/mineinabyss/launchy/data/config/ModpackUserConfig.kt b/src/main/kotlin/com/mineinabyss/launchy/data/config/ModpackUserConfig.kt
@@ -1,23 +1,57 @@
 package com.mineinabyss.launchy.data.config
 
 import com.charleskorn.kaml.decodeFromStream
-import com.mineinabyss.launchy.data.*
-import com.mineinabyss.launchy.data.modpacks.PackDependencies
+import com.mineinabyss.launchy.data.Formats
+import com.mineinabyss.launchy.data.GroupName
+import com.mineinabyss.launchy.data.ModID
+import com.mineinabyss.launchy.data.ModName
+import com.mineinabyss.launchy.data.modpacks.InstanceModLoaders
+import com.mineinabyss.launchy.logic.ModDownloader
+import com.mineinabyss.launchy.logic.hashing.Hashing.checksum
 import kotlinx.serialization.Serializable
+import kotlinx.serialization.Transient
 import kotlinx.serialization.encodeToString
 import java.nio.file.Path
+import java.security.MessageDigest
 import kotlin.io.path.*
 
+enum class HashCheck {
+    UNKNOWN, VERIFIED, FAILED
+}
+
+@Serializable
+data class DownloadInfo(
+    val url: String,
+    val path: String,
+    val desiredHash: String?,
+    val hashCheck: HashCheck,
+    val result: ModDownloader.DownloadResult,
+) {
+    @Transient
+    val systemPath = Path(path)
+
+    fun failed(): Boolean {
+        return result == ModDownloader.DownloadResult.Failed
+                || systemPath.isRegularFile()
+                || (desiredHash != null && hashCheck == HashCheck.FAILED)
+    }
+
+    fun calculateSha1Hash(minecraftDir: Path): String {
+        val md = MessageDigest.getInstance("SHA-1")
+        return (minecraftDir / systemPath).checksum(md)
+    }
+}
+
 @Serializable
 data class ModpackUserConfig(
-    val userAgreedDeps: PackDependencies? = null,
+    val userAgreedDeps: InstanceModLoaders? = null,
     val fullEnabledGroups: Set<GroupName> = setOf(),
     val fullDisabledGroups: Set<GroupName> = setOf(),
     val toggledMods: Set<ModName> = setOf(),
     val toggledConfigs: Set<ModName> = setOf(),
     val seenGroups: Set<GroupName> = setOf(),
-    val modDownloads: Map<ModName, DownloadURL> = mapOf(),
-    val modConfigs: Map<ModName, ConfigURL> = mapOf(),
+    val modDownloadInfo: Map<ModID, DownloadInfo> = mapOf(),
+//    val configDownloadInfo: Map<ModID, DownloadInfo> = mapOf(),
     val downloadUpdates: Boolean = true,
 ) {
     fun save(file: Path) {

diff --git a/src/main/kotlin/com/mineinabyss/launchy/data/modpacks/ExtraPackInfo.kt b/src/main/kotlin/com/mineinabyss/launchy/data/modpacks/ExtraPackInfo.kt
@@ -5,7 +5,7 @@ import kotlinx.serialization.Serializable
 @Serializable
 class ModReference(
     val urlContains: String,
-    val info: ModInfo? = null,
+    val info: ModConfig? = null,
 )
 @Serializable
 class ExtraPackInfo(

diff --git a/...launchy/data/modpacks/PackDependencies.kt → ...unchy/data/modpacks/InstanceModLoaders.kt b/...launchy/data/modpacks/PackDependencies.kt → ...unchy/data/modpacks/InstanceModLoaders.kt
@@ -5,7 +5,7 @@ import kotlinx.serialization.Serializable
 import kotlinx.serialization.Transient
 
 @Serializable
-data class PackDependencies(
+data class InstanceModLoaders(
     val minecraft: String,
     @SerialName("fabric-loader")
     val fabricLoader: String? = null,

diff --git a/src/main/kotlin/com/mineinabyss/launchy/data/modpacks/Mod.kt b/src/main/kotlin/com/mineinabyss/launchy/data/modpacks/Mod.kt
@@ -1,21 +1,24 @@
 package com.mineinabyss.launchy.data.modpacks
 
 import com.mineinabyss.launchy.data.Dirs
+import com.mineinabyss.launchy.data.modpacks.formats.ModrinthPackFormat
+import io.ktor.http.*
 import java.nio.file.Path
 import kotlin.io.path.div
-import kotlin.io.path.exists
 
 data class Mod(
-    val packDir: Path,
-    val info: ModInfo
+    private val downloadDir: Path,
+    val info: ModConfig,
+    val modId: String,
+    val desiredHashes: ModrinthPackFormat.Hashes?,
 ) {
-    val file =
-        if (info.downloadPath != null) packDir / info.downloadPath
-        else packDir / "mods" / "${info.name}.jar"
+    val absoluteDownloadDest =
+        if (info.downloadPath != null) downloadDir / info.downloadPath.validated
+        else downloadDir / "mods" / "${info.id ?: info.name}.jar"
 
-    val config = Dirs.tmp / "${info.name}-config.zip"
+    val downloadUrl: Url = Url(info.url)
 
-    val isDownloaded get() = file.exists()
+    val config = Dirs.tmp / "${info.name}-config.zip"
 
 
     fun compatibleWith(other: Mod) =

diff --git a/...einabyss/launchy/data/modpacks/ModInfo.kt → ...nabyss/launchy/data/modpacks/ModConfig.kt b/...einabyss/launchy/data/modpacks/ModInfo.kt → ...nabyss/launchy/data/modpacks/ModConfig.kt
@@ -1,9 +1,11 @@
 package com.mineinabyss.launchy.data.modpacks
 
+import com.mineinabyss.launchy.data.modpacks.formats.ModDownloadPath
 import kotlinx.serialization.Serializable
 
 @Serializable
-data class ModInfo(
+data class ModConfig(
+    val id: String? = null,
     val name: String,
     val license: String = "",
     val homepage: String = "",
@@ -14,6 +16,6 @@ data class ModInfo(
     val forceConfigDownload: Boolean = false,
     val dependency: Boolean = false,
     val incompatibleWith: List<String> = emptyList(),
-    val downloadPath: String? = null,
+    val downloadPath: ModDownloadPath? = null,
     val requires: List<String> = emptyList(),
 )
diff --git a/src/main/kotlin/com/mineinabyss/launchy/data/modpacks/Modpack.kt b/src/main/kotlin/com/mineinabyss/launchy/data/modpacks/Modpack.kt
@@ -3,7 +3,7 @@ package com.mineinabyss.launchy.data.modpacks
 import java.nio.file.Path
 
 class Modpack(
-    val dependencies: PackDependencies,
+    val modLoaders: InstanceModLoaders,
     val mods: Mods,
     val overridesPaths: List<Path> = listOf(),
 )
diff --git a/src/main/kotlin/com/mineinabyss/launchy/data/modpacks/formats/ExtraInfoFormat.kt b/src/main/kotlin/com/mineinabyss/launchy/data/modpacks/formats/ExtraInfoFormat.kt
@@ -11,8 +11,8 @@ data class ExtraInfoFormat(
     val format: PackFormat,
     val extraInfoPack: ExtraPackInfo,
 ) : PackFormat by format {
-    override fun toGenericMods(minecraftDir: Path): Mods {
-        val originalMods = format.toGenericMods(minecraftDir)
+    override fun toGenericMods(downloadsDir: Path): Mods {
+        val originalMods = format.toGenericMods(downloadsDir)
         val foundMods = mutableSetOf<Mod>()
         val mods: Map<Group, Set<Mod>> = extraInfoPack.modGroups
             .mapKeys { (name, _) -> extraInfoPack.groups.single { it.name == name } }

diff --git a/src/main/kotlin/com/mineinabyss/launchy/data/modpacks/formats/LaunchyPackFormat.kt b/src/main/kotlin/com/mineinabyss/launchy/data/modpacks/formats/LaunchyPackFormat.kt
@@ -10,16 +10,25 @@ data class LaunchyPackFormat(
     val fabricVersion: String? = null,
     val minecraftVersion: String,
     val groups: Set<Group>,
-    private val modGroups: Map<GroupName, Set<ModInfo>>,
+    private val modGroups: Map<GroupName, Set<ModConfig>>,
 ) : PackFormat {
-    override fun toGenericMods(minecraftDir: Path): Mods {
+    override fun toGenericMods(downloadsDir: Path): Mods {
         return Mods(modGroups
             .mapKeys { (name, _) -> groups.single { it.name == name } }
-            .mapValues { (_, mods) -> mods.map { Mod(minecraftDir, it) }.toSet() })
+            .mapValues { (_, mods) ->
+                mods.map {
+                    Mod(
+                        downloadDir = downloadsDir,
+                        info = it,
+                        modId = it.id ?: it.name,
+                        desiredHashes = null,
+                    )
+                }.toSet()
+            })
     }
 
-    override fun getDependencies(minecraftDir: Path): PackDependencies {
-        return PackDependencies(minecraft = minecraftVersion, fabricLoader = fabricVersion)
+    override fun getModLoaders(): InstanceModLoaders {
+        return InstanceModLoaders(minecraft = minecraftVersion, fabricLoader = fabricVersion)
     }
 
     override fun getOverridesPaths(configDir: Path): List<Path> = emptyList()

diff --git a/src/main/kotlin/com/mineinabyss/launchy/data/modpacks/formats/ModDownloadPath.kt b/src/main/kotlin/com/mineinabyss/launchy/data/modpacks/formats/ModDownloadPath.kt
@@ -0,0 +1,32 @@
+package com.mineinabyss.launchy.data.modpacks.formats
+
+import kotlinx.serialization.KSerializer
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.descriptors.PrimitiveKind
+import kotlinx.serialization.descriptors.PrimitiveSerialDescriptor
+import kotlinx.serialization.descriptors.SerialDescriptor
+import kotlinx.serialization.encoding.Decoder
+import kotlinx.serialization.encoding.Encoder
+import java.nio.file.Path
+import kotlin.io.path.Path
+
+@Serializable(with = ValidModPathSerializer::class)
+class ModDownloadPath(
+    val validated: Path
+)
+
+object ValidModPathSerializer : KSerializer<ModDownloadPath> {
+    override val descriptor: SerialDescriptor = PrimitiveSerialDescriptor("modPath", PrimitiveKind.STRING)
+    override fun deserialize(decoder: Decoder): ModDownloadPath {
+        val pathString = decoder.decodeString()
+        if (pathString.contains("..")) error("Mod path cannot contain ..")
+        val path = Path(pathString)
+        if (path.isAbsolute) error("Path cannot be absolute")
+        return ModDownloadPath(path)
+    }
+
+    override fun serialize(encoder: Encoder, value: ModDownloadPath) {
+        encoder.encodeString(value.validated.toString())
+    }
+
+}
diff --git a/src/main/kotlin/com/mineinabyss/launchy/data/modpacks/formats/ModrinthPackFormat.kt b/src/main/kotlin/com/mineinabyss/launchy/data/modpacks/formats/ModrinthPackFormat.kt
@@ -1,16 +1,16 @@
 package com.mineinabyss.launchy.data.modpacks.formats
 
+import com.mineinabyss.launchy.data.modpacks.InstanceModLoaders
 import com.mineinabyss.launchy.data.modpacks.Mod
-import com.mineinabyss.launchy.data.modpacks.ModInfo
+import com.mineinabyss.launchy.data.modpacks.ModConfig
 import com.mineinabyss.launchy.data.modpacks.Mods
-import com.mineinabyss.launchy.data.modpacks.PackDependencies
 import kotlinx.serialization.Serializable
 import java.nio.file.Path
 import kotlin.io.path.div
 
 @Serializable
 data class ModrinthPackFormat(
-    val dependencies: PackDependencies,
+    val dependencies: InstanceModLoaders,
     val files: List<PackFile>,
     val formatVersion: Int,
     val name: String,
@@ -20,25 +20,34 @@ data class ModrinthPackFormat(
     data class PackFile(
         val downloads: List<String>,
         val fileSize: Long,
-        val path: String,
+        val path: ModDownloadPath,
+        val hashes: Hashes,
     ) {
         fun toMod(packDir: Path) = Mod(
             packDir,
-            ModInfo(
-                name = path.removePrefix("mods/").removeSuffix(".jar"),
+            ModConfig(
+                name = path.validated.toString().removePrefix("mods/").removeSuffix(".jar"),
                 desc = "",
                 url = downloads.single(),
                 downloadPath = path,
-            )
+            ),
+            modId = downloads.single().removePrefix("https://cdn.modrinth.com/data/").substringBefore("/versions"),
+            desiredHashes = hashes,
         )
     }
 
-    override fun getDependencies(minecraftDir: Path): PackDependencies {
+    @Serializable
+    data class Hashes(
+        val sha1: String,
+        val sha512: String,
+    )
+
+    override fun getModLoaders(): InstanceModLoaders {
         return dependencies
     }
 
-    override fun toGenericMods(minecraftDir: Path) =
-        Mods.withSingleGroup(files.map { it.toMod(minecraftDir) })
+    override fun toGenericMods(downloadsDir: Path) =
+        Mods.withSingleGroup(files.map { it.toMod(downloadsDir) })
 
     override fun getOverridesPaths(configDir: Path): List<Path> = listOf(configDir / "mrpack" / "overrides")
 }

diff --git a/src/main/kotlin/com/mineinabyss/launchy/data/modpacks/formats/PackFormat.kt b/src/main/kotlin/com/mineinabyss/launchy/data/modpacks/formats/PackFormat.kt
@@ -1,13 +1,13 @@
 package com.mineinabyss.launchy.data.modpacks.formats
 
+import com.mineinabyss.launchy.data.modpacks.InstanceModLoaders
 import com.mineinabyss.launchy.data.modpacks.Mods
-import com.mineinabyss.launchy.data.modpacks.PackDependencies
 import java.nio.file.Path
 
 sealed interface PackFormat {
-    fun toGenericMods(minecraftDir: Path): Mods
+    fun toGenericMods(downloadsDir: Path): Mods
 
-    fun getDependencies(minecraftDir: Path): PackDependencies
+    fun getModLoaders(): InstanceModLoaders
 
     fun getOverridesPaths(configDir: Path): List<Path>
 }