MultiMC metadata: Support updating NeoForge version (#75)

Removed a deleteIfExists call - this should be handled by DownloadTask instead

.github/workflows/pr.yml

@@ -0,0 +1,27 @@
+name: Java Gradle Build
+
+on:
+  pull_request
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Set up JDK 8
+        uses: actions/setup-java@v2
+        with:
+          java-version: '8'
+          distribution: 'temurin'
+          cache: gradle
+      - name: Build with Gradle
+        run: ./gradlew build
+      - name: Cleanup Gradle Cache
+        # Remove some files from the Gradle cache, so they aren't cached by GitHub Actions.
+        # Restoring these files from a GitHub Actions cache might cause problems for future builds.
+        run: |
+          rm -f ~/.gradle/caches/modules-2/modules-2.lock
+          rm -f ~/.gradle/caches/modules-2/gc.properties

.github/workflows/snapshot.yml

@@ -1,6 +1,9 @@
 name: Java Gradle Snapshot
 
-on: ["push", "pull_request"]
+on:
+  push:
+    branches:
+      - 'main'
 
 jobs:
   build:

src/main/kotlin/link/infra/packwiz/installer/DownloadTask.kt

@@ -21,6 +21,7 @@ import java.nio.file.StandardCopyOption
 
 internal class DownloadTask private constructor(val metadata: IndexFile.File, val index: IndexFile, private val downloadSide: Side) : IOptionDetails {
 	var cachedFile: ManifestFile.File? = null
+		private set
 
 	private var err: Exception? = null
 	val exceptionDetails get() = err?.let { e -> ExceptionDetails(name, e) }
@@ -28,10 +29,24 @@ internal class DownloadTask private constructor(val metadata: IndexFile.File, va
 	fun failed() = err != null
 
 	var alreadyUpToDate = false
+		private set
 	private var metadataRequired = true
 	private var invalidated = false
 	// If file is new or isOptional changed to true, the option needs to be presented again
 	private var newOptional = true
+	var completionStatus = CompletionStatus.INCOMPLETE
+		private set
+
+	enum class CompletionStatus {
+		INCOMPLETE,
+		DOWNLOADED,
+		ALREADY_EXISTS_CACHED,
+		ALREADY_EXISTS_VALIDATED,
+		SKIPPED_DISABLED,
+		SKIPPED_WRONG_SIDE,
+		DELETED_DISABLED,
+		DELETED_WRONG_SIDE;
+	}
 
 	val isOptional get() = metadata.linkedFile?.option?.optional ?: false
 
@@ -76,6 +91,7 @@ internal class DownloadTask private constructor(val metadata: IndexFile.File, va
 			if (currHash == cachedFile.hash) { // Already up to date
 				alreadyUpToDate = true
 				metadataRequired = false
+				completionStatus = CompletionStatus.ALREADY_EXISTS_CACHED
 			}
 		}
 		if (cachedFile.isOptional) {
@@ -109,12 +125,12 @@ internal class DownloadTask private constructor(val metadata: IndexFile.File, va
 							cachedFile.optionValue = linkedFile.option.defaultValue
 						}
 					}
+				}
 				cachedFile.isOptional = isOptional
 				cachedFile.onlyOtherSide = !correctSide()
 			}
 		}
 	}
-	}
 
 	/**
 	 * Check if the file in the destination location is already valid
@@ -143,6 +159,7 @@ internal class DownloadTask private constructor(val metadata: IndexFile.File, va
 					fileSource.buffer().readAll(blackholeSink())
 					if (hash == fileSource.hash) {
 						alreadyUpToDate = true
+						completionStatus = CompletionStatus.ALREADY_EXISTS_VALIDATED
 
 						// Update the manifest file
 						cachedFile = (cachedFile ?: ManifestFile.File()).also {
@@ -181,10 +198,18 @@ internal class DownloadTask private constructor(val metadata: IndexFile.File, va
 				if (it.cachedLocation != null) {
 					// Ensure wrong-side or optional false files are removed
 					try {
-						Files.deleteIfExists(it.cachedLocation!!.nioPath)
+						completionStatus = if (Files.deleteIfExists(it.cachedLocation!!.nioPath)) {
+							if (correctSide()) { CompletionStatus.DELETED_DISABLED } else { CompletionStatus.DELETED_WRONG_SIDE }
+						} else {
+							if (correctSide()) { CompletionStatus.SKIPPED_DISABLED } else { CompletionStatus.SKIPPED_WRONG_SIDE }
+						}
 					} catch (e: IOException) {
 						Log.warn("Failed to delete file", e)
 					}
+				} else {
+					completionStatus =
+						if (correctSide()) { CompletionStatus.SKIPPED_DISABLED }
+						else { CompletionStatus.SKIPPED_WRONG_SIDE }
 				}
 				it.cachedLocation = null
 				return
@@ -284,6 +309,8 @@ internal class DownloadTask private constructor(val metadata: IndexFile.File, va
 				}
 			}
 		}
+
+		completionStatus = CompletionStatus.DOWNLOADED
 	}
 
 	companion object {

src/main/kotlin/link/infra/packwiz/installer/LauncherUtils.kt

@@ -48,6 +48,7 @@ class LauncherUtils internal constructor(private val opts: UpdateManager.Options
 		val modLoaders = hashMapOf(
 			"net.minecraft" to "minecraft",
 			"net.minecraftforge" to "forge",
+			"net.neoforged" to "neoforge",
 			"net.fabricmc.fabric-loader" to "fabric",
 			"org.quiltmc.quilt-loader" to "quilt",
 			"com.mumfrey.liteloader" to "liteloader"
@@ -59,6 +60,7 @@ class LauncherUtils internal constructor(private val opts: UpdateManager.Options
 			"org.lwjgl" to -1,
 			"org.lwjgl3" to -1,
 			"net.minecraftforge" to 5,
+			"net.neoforged" to 5,
 			"net.fabricmc.fabric-loader" to 10,
 			"org.quiltmc.quilt-loader" to 10,
 			"com.mumfrey.liteloader" to 10,

src/main/kotlin/link/infra/packwiz/installer/UpdateManager.kt

@@ -23,7 +23,6 @@ import link.infra.packwiz.installer.ui.IUserInterface.ExceptionListResult
 import link.infra.packwiz.installer.ui.data.InstallProgress
 import link.infra.packwiz.installer.util.Log
 import okio.buffer
-import java.io.FileWriter
 import java.io.IOException
 import java.io.InputStreamReader
 import java.nio.charset.StandardCharsets
@@ -128,8 +127,11 @@ class UpdateManager internal constructor(private val opts: Options, val ui: IUse
 
 		ui.submitProgress(InstallProgress("Checking local files..."))
 
-		// Invalidation checking must be done here, as it must happen before pack/index hashes are checked
+		// If the side changes, invalidate EVERYTHING (even when the index hasn't changed)
+		val invalidateAll = opts.side != manifest.cachedSide
 		val invalidatedUris: MutableList<PackwizFilePath> = ArrayList()
+		if (!invalidateAll) {
+			// Invalidation checking must be done here, as it must happen before pack/index hashes are checked
 			for ((fileUri, file) in manifest.cachedFiles) {
 				// ignore onlyOtherSide files
 				if (file.onlyOtherSide) {
@@ -164,6 +166,7 @@ class UpdateManager internal constructor(private val opts: Options, val ui: IUse
 					return
 				}
 			}
+		}
 
 		Log.info("Modpack name: ${pf.name}")
 
@@ -178,6 +181,7 @@ class UpdateManager internal constructor(private val opts: Options, val ui: IUse
 				pf.index.hashFormat,
 				manifest,
 				invalidatedUris,
+				invalidateAll,
 				clientHolder
 			)
 		} catch (e1: Exception) {
@@ -197,13 +201,14 @@ class UpdateManager internal constructor(private val opts: Options, val ui: IUse
 
 		manifest.cachedSide = opts.side
 		try {
-			FileWriter(opts.manifestFile.nioPath.toFile()).use { writer -> gson.toJson(manifest, writer) }
+			Files.newBufferedWriter(opts.manifestFile.nioPath, StandardCharsets.UTF_8).use { writer -> gson.toJson(manifest, writer) }
 		} catch (e: IOException) {
 			ui.showErrorAndExit("Failed to save local manifest file", e)
 		}
 	}
 
-	private fun processIndex(indexUri: PackwizPath<*>, indexHash: Hash<*>, hashFormat: HashFormat<*>, manifest: ManifestFile, invalidatedFiles: List<PackwizFilePath>, clientHolder: ClientHolder) {
+	private fun processIndex(indexUri: PackwizPath<*>, indexHash: Hash<*>, hashFormat: HashFormat<*>, manifest: ManifestFile, invalidatedFiles: List<PackwizFilePath>, invalidateAll: Boolean, clientHolder: ClientHolder) {
+		if (!invalidateAll) {
 			if (manifest.indexFileHash == indexHash && invalidatedFiles.isEmpty()) {
 				ui.submitProgress(InstallProgress("Modpack files are already up to date!", 1, 1))
 				if (manifest.cachedFiles.any { it.value.isOptional }) {
@@ -217,6 +222,7 @@ class UpdateManager internal constructor(private val opts: Options, val ui: IUse
 					return
 				}
 			}
+		}
 		manifest.indexFileHash = indexHash
 
 		val indexFileSource = try {
@@ -241,31 +247,17 @@ class UpdateManager internal constructor(private val opts: Options, val ui: IUse
 		}
 
 		ui.submitProgress(InstallProgress("Checking local files..."))
-		// TODO: use kotlin filtering/FP rather than an iterator?
 		val it: MutableIterator<Map.Entry<PackwizFilePath, ManifestFile.File>> = manifest.cachedFiles.entries.iterator()
 		while (it.hasNext()) {
 			val (uri, file) = it.next()
 			if (file.cachedLocation != null) {
-				var alreadyDeleted = false
-				// Delete if option value has been set to false
-				if (file.isOptional && !file.optionValue) {
-					try {
-						Files.deleteIfExists(file.cachedLocation!!.nioPath)
-					} catch (e: IOException) {
-						Log.warn("Failed to delete optional disabled file", e)
-					}
-					// Set to null, as it doesn't exist anymore
-					file.cachedLocation = null
-					alreadyDeleted = true
-				}
 				if (indexFile.files.none { it.file.rebase(opts.packFolder) == uri }) { // File has been removed from the index
-					if (!alreadyDeleted) {
 					try {
 						Files.deleteIfExists(file.cachedLocation!!.nioPath)
 					} catch (e: IOException) {
 						Log.warn("Failed to delete file removed from index", e)
 					}
-					}
+					Log.info("Deleted ${file.cachedLocation!!.filename} (removed from pack)")
 					it.remove()
 				}
 			}
@@ -282,9 +274,6 @@ class UpdateManager internal constructor(private val opts: Options, val ui: IUse
 			Log.warn("Index is empty!")
 		}
 		val tasks = createTasksFromIndex(indexFile, opts.side)
-		// If the side changes, invalidate EVERYTHING just in case
-		// Might not be needed, but done just to be safe
-		val invalidateAll = opts.side != manifest.cachedSide
 		if (invalidateAll) {
 			Log.info("Side changed, invalidating all mods")
 		}
@@ -398,7 +387,16 @@ class UpdateManager internal constructor(private val opts: Options, val ui: IUse
 			val progress = if (exDetails != null) {
 				"Failed to download ${exDetails.name}: ${exDetails.exception.message}"
 			} else {
-				"Downloaded ${task.name}"
+				when (task.completionStatus) {
+					DownloadTask.CompletionStatus.INCOMPLETE -> "${task.name} pending (you should never see this...)"
+					DownloadTask.CompletionStatus.DOWNLOADED -> "Downloaded ${task.name}"
+					DownloadTask.CompletionStatus.ALREADY_EXISTS_CACHED -> "${task.name} already exists (cached)"
+					DownloadTask.CompletionStatus.ALREADY_EXISTS_VALIDATED -> "${task.name} already exists (validated)"
+					DownloadTask.CompletionStatus.SKIPPED_DISABLED -> "Skipped ${task.name} (disabled)"
+					DownloadTask.CompletionStatus.SKIPPED_WRONG_SIDE -> "Skipped ${task.name} (wrong side)"
+					DownloadTask.CompletionStatus.DELETED_DISABLED -> "Deleted ${task.name} (disabled)"
+					DownloadTask.CompletionStatus.DELETED_WRONG_SIDE -> "Deleted ${task.name} (wrong side)"
+				}
 			}
 			ui.submitProgress(InstallProgress(progress, i + 1, tasks.size))
 

src/main/kotlin/link/infra/packwiz/installer/metadata/curseforge/CurseForgeSourcer.kt

@@ -49,14 +49,15 @@ private val APIKey = "JDJhJDEwJHNBWVhqblU1N0EzSmpzcmJYM3JVdk92UWk2NHBLS3BnQ2VpbG
 @Throws(JsonSyntaxException::class, JsonIOException::class)
 fun resolveCfMetadata(mods: List<IndexFile.File>, packFolder: PackwizFilePath, clientHolder: ClientHolder): List<ExceptionDetails> {
 	val failures = mutableListOf<ExceptionDetails>()
-	val fileIdMap = mutableMapOf<Int, IndexFile.File>()
+	val fileIdMap = mutableMapOf<Int, List<IndexFile.File>>()
 
 	for (mod in mods) {
 		if (!mod.linkedFile!!.update.contains("curseforge")) {
 			failures.add(ExceptionDetails(mod.linkedFile!!.name, Exception("Failed to resolve CurseForge metadata: no CurseForge update section")))
 			continue
 		}
-		fileIdMap[(mod.linkedFile!!.update["curseforge"] as CurseForgeUpdateData).fileId] = mod
+		val fileId = (mod.linkedFile!!.update["curseforge"] as CurseForgeUpdateData).fileId
+		fileIdMap[fileId] = (fileIdMap[fileId] ?: listOf()) + mod
 	}
 
 	val reqData = GetFilesRequest(fileIdMap.keys.toList())
@@ -77,7 +78,7 @@ fun resolveCfMetadata(mods: List<IndexFile.File>, packFolder: PackwizFilePath, c
 	val resData = Gson().fromJson(res.body!!.charStream(), GetFilesResponse::class.java)
 	res.closeQuietly()
 
-	val manualDownloadMods = mutableMapOf<Int, Pair<IndexFile.File, Int>>()
+	val manualDownloadMods = mutableMapOf<Int, List<Int>>()
 	for (file in resData.data) {
 		if (!fileIdMap.contains(file.id)) {
 			failures.add(ExceptionDetails(file.id.toString(),
@@ -85,12 +86,14 @@ fun resolveCfMetadata(mods: List<IndexFile.File>, packFolder: PackwizFilePath, c
 			continue
 		}
 		if (file.downloadUrl == null) {
-			manualDownloadMods[file.modId] = Pair(fileIdMap[file.id]!!, file.id)
+			manualDownloadMods[file.modId] = (manualDownloadMods[file.modId] ?: listOf()) + file.id
 			continue
 		}
 		try {
-			fileIdMap[file.id]!!.linkedFile!!.resolvedUpdateData["curseforge"] =
+			for (indexFile in fileIdMap[file.id]!!) {
+				indexFile.linkedFile!!.resolvedUpdateData["curseforge"] =
 					HttpUrlPath(file.downloadUrl!!.toHttpUrl())
+			}
 		} catch (e: IllegalArgumentException) {
 			failures.add(ExceptionDetails(file.id.toString(),
 				Exception("Failed to parse URL: ${file.downloadUrl} for ID ${file.id}, Project ID ${file.modId}", e)))
@@ -99,10 +102,13 @@ fun resolveCfMetadata(mods: List<IndexFile.File>, packFolder: PackwizFilePath, c
 
 	// Some file types don't show up in the API at all! (e.g. shaderpacks)
 	// Add unresolved files to manualDownloadMods
-	for ((fileId, file) in fileIdMap) {
+	for ((fileId, indexFiles) in fileIdMap) {
+		for (file in indexFiles) {
 			if (file.linkedFile != null) {
 				if (file.linkedFile!!.resolvedUpdateData["curseforge"] == null) {
-				manualDownloadMods[(file.linkedFile!!.update["curseforge"] as CurseForgeUpdateData).projectId] = Pair(file, fileId)
+					val projectId = (file.linkedFile!!.update["curseforge"] as CurseForgeUpdateData).projectId
+					manualDownloadMods[projectId] = (manualDownloadMods[projectId] ?: listOf()) + fileId
+				}
 			}
 		}
 	}
@@ -133,9 +139,19 @@ fun resolveCfMetadata(mods: List<IndexFile.File>, packFolder: PackwizFilePath, c
 				continue
 			}
 
-			val modFile = manualDownloadMods[mod.id]!!
-			failures.add(ExceptionDetails(mod.name, Exception("This mod is excluded from the CurseForge API and must be downloaded manually.\n" +
-				"Please go to ${mod.links?.websiteUrl}/files/${modFile.second} and save this file to ${modFile.first.destURI.rebase(packFolder).nioPath.absolute()}")))
+			for (fileId in manualDownloadMods[mod.id]!!) {
+				if (!fileIdMap.contains(fileId)) {
+					failures.add(ExceptionDetails(mod.name,
+						Exception("Failed to find file from result: file ID $fileId")))
+					continue
+				}
+
+				for (indexFile in fileIdMap[fileId]!!) {
+					var modUrl = "${mod.links?.websiteUrl}/files/${fileId}"
+					failures.add(ExceptionDetails(indexFile.name, Exception("This mod is excluded from the CurseForge API and must be downloaded manually.\n" +
+						"Please go to ${modUrl} and save this file to ${indexFile.destURI.rebase(packFolder).nioPath.absolute()}"), modUrl))
+				}
+			}
 		}
 	}
 

src/main/kotlin/link/infra/packwiz/installer/target/Side.kt

@@ -4,42 +4,29 @@ import cc.ekblad.toml.model.TomlValue
 import cc.ekblad.toml.tomlMapper
 import com.google.gson.annotations.SerializedName
 
-enum class Side {
+enum class Side(sideName: String) {
 	@SerializedName("client")
 	CLIENT("client"),
 	@SerializedName("server")
 	SERVER("server"),
 	@SerializedName("both")
 	@Suppress("unused")
-	BOTH("both", arrayOf(CLIENT, SERVER));
+	BOTH("both") {
+		override fun hasSide(tSide: Side): Boolean {
+			return true
+		}
+	};
 
 	private val sideName: String
-	private val depSides: Array<Side>?
 
-	constructor(sideName: String) {
+	init {
 		this.sideName = sideName.lowercase()
-		depSides = null
-	}
-
-	constructor(sideName: String, depSides: Array<Side>) {
-		this.sideName = sideName.lowercase()
-		this.depSides = depSides
 	}
 
 	override fun toString() = sideName
 
-	fun hasSide(tSide: Side): Boolean {
-		if (this == tSide) {
-			return true
-		}
-		if (depSides != null) {
-			for (depSide in depSides) {
-				if (depSide == tSide) {
-					return true
-				}
-			}
-		}
-		return false
+	open fun hasSide(tSide: Side): Boolean {
+		return this == tSide || tSide == BOTH
 	}
 
 	companion object {

src/main/kotlin/link/infra/packwiz/installer/ui/IUserInterface.kt

@@ -23,7 +23,10 @@ interface IUserInterface {
 
 	fun showCancellationDialog(): CancellationResult = CancellationResult.QUIT
 
-	fun showUpdateConfirmationDialog(oldVersions: List<Pair<String, String?>>, newVersions: List<Pair<String, String?>>): UpdateConfirmationResult = UpdateConfirmationResult.CANCELLED
+	fun showUpdateConfirmationDialog(oldVersions: List<Pair<String, String?>>, newVersions: List<Pair<String, String?>>): UpdateConfirmationResult {
+		// Always update metadata when using the CLI
+		return UpdateConfirmationResult.UPDATE
+	}
 
 	fun awaitOptionalButton(showCancel: Boolean, timeout: Long)
 

src/main/kotlin/link/infra/packwiz/installer/ui/data/ExceptionDetails.kt

@@ -2,5 +2,6 @@ package link.infra.packwiz.installer.ui.data
 
 data class ExceptionDetails(
 		val name: String,
-		val exception: Exception
+		val exception: Exception,
+		val modUrl: String? = null
 )

src/main/kotlin/link/infra/packwiz/installer/ui/gui/ExceptionListWindow.kt

@@ -1,5 +1,6 @@
 package link.infra.packwiz.installer.ui.gui
 
+import link.infra.packwiz.installer.util.Log
 import link.infra.packwiz.installer.ui.IUserInterface
 import link.infra.packwiz.installer.ui.data.ExceptionDetails
 import java.awt.BorderLayout
@@ -24,6 +25,24 @@ class ExceptionListWindow(eList: List<ExceptionDetails>, future: CompletableFutu
 		fun getExceptionAt(index: Int) = details[index].exception
 	}
 
+	private fun openUrl(url: String) {
+		try {
+			if (Desktop.isDesktopSupported() && Desktop.getDesktop().isSupported(Desktop.Action.BROWSE)) {
+				Desktop.getDesktop().browse(URI(url))
+			} else {
+				val process = Runtime.getRuntime().exec(arrayOf("xdg-open", url));
+				val exitValue = process.waitFor()
+				if (exitValue > 0) {
+					Log.warn("Failed to open $url: xdg-open exited with code $exitValue")
+				}
+			}
+		} catch (e: IOException) {
+			Log.warn("Failed to open $url", e)
+		} catch (e: URISyntaxException) {
+			Log.warn("Failed to open $url", e)
+		}
+	}
+
 	/**
 	 * Create the dialog.
 	 */
@@ -112,6 +131,19 @@ class ExceptionListWindow(eList: List<ExceptionDetails>, future: CompletableFutu
 							this@ExceptionListWindow.dispose()
 						}
 					})
+
+					val missingMods = eList.filter { it.modUrl != null }.map { it.modUrl!! }.toSet()
+
+					if (!missingMods.isEmpty()) {
+						add(JButton("Open missing mods").apply {
+							toolTipText = "Open missing mods in your browser"
+							addActionListener {
+								missingMods.forEach {
+									openUrl(it)
+								}
+							}
+						})
+					}
 				}, BorderLayout.EAST)
 
 				// Errored label
@@ -122,16 +154,8 @@ class ExceptionListWindow(eList: List<ExceptionDetails>, future: CompletableFutu
 				// Left buttons
 				add(JPanel().apply {
 					add(JButton("Report issue").apply {
-						if (Desktop.isDesktopSupported() && Desktop.getDesktop().isSupported(Desktop.Action.BROWSE)) {
 						addActionListener {
-								try {
-									Desktop.getDesktop().browse(URI("https://github.com/packwiz/packwiz-installer/issues/new"))
-								} catch (e: IOException) {
-									// lol the button just won't work i guess
-								} catch (e: URISyntaxException) {}
-							}
-						} else {
-							isEnabled = false
+							openUrl("https://github.com/packwiz/packwiz-installer/issues/new")
 						}
 					})
 				}, BorderLayout.WEST)