Fix onlyOtherSide state not updating properly when side changes (fixes #60)

* Add option to automatically close after a user-specific amount of time

Add the -t/--timeout command line option to specific a number of seconds to
wait before automatically closing if there is no update or user-interactivity
required.

* Also use timeout setting when prompting about optional mods after/during an update

Additionally, clears the TODO comment.

* Change default timeout to 10 seconds

.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:

build.gradle.kts

@@ -22,7 +22,7 @@ repositories {
 }
 
 val r8 by configurations.creating
-val shrinkJarOutput by configurations.creating {
+val distJarOutput by configurations.creating {
 	isCanBeResolved = false
 	isCanBeConsumed = true
 
@@ -104,15 +104,27 @@ val shrinkJar by tasks.registering(JavaExec::class) {
 	)
 }
 
+// MANIFEST.MF must be one of the first 2 entries in the zip for JarInputStream to see it
+// Gradle's JAR creation handles this whereas R8 doesn't, so the dist JAR is repacked
+val distJar by tasks.registering(Jar::class) {
+	from(shrinkJar.map { zipTree(it.outputs.files.singleFile) })
+	archiveClassifier.set("all-repacked")
+	manifest {
+		from(shrinkJar.map { zipTree(it.outputs.files.singleFile).matching {
+			include("META-INF/MANIFEST.MF")
+		}.singleFile })
+	}
+}
+
 artifacts {
-	add("shrinkJarOutput", shrinkJar) {
+	add("distJarOutput", distJar) {
 		classifier = "dist"
 	}
 }
 
 // Used for vscode launch.json
 val copyJar by tasks.registering(Copy::class) {
-	from(shrinkJar)
+	from(distJar)
 	rename("packwiz-installer-(.*)\\.jar", "packwiz-installer.jar")
 	into(layout.buildDirectory.dir("dist"))
 	outputs.file(layout.buildDirectory.dir("dist").map { it.file("packwiz-installer.jar") })
@@ -130,12 +142,11 @@ githubRelease {
 	draft(true)
 	token(findProperty("github.token") as String?)
 	releaseAssets(layout.buildDirectory.dir("dist").map { it.file("packwiz-installer.jar") }.get())
-	dryRun(project.findProperty("release") != "true")
 }
 
 tasks.githubRelease {
 	dependsOn(copyJar)
-	enabled = project.hasProperty("github.token")
+	enabled = project.hasProperty("github.token") && project.findProperty("release") == "true"
 }
 
 tasks.publish {
@@ -156,7 +167,7 @@ tasks.compileTestKotlin {
 }
 
 val javaComponent = components["java"] as AdhocComponentWithVariants
-javaComponent.addVariantsFromConfiguration(shrinkJarOutput) {
+javaComponent.addVariantsFromConfiguration(distJarOutput) {
 	mapToMavenScope("runtime")
 	mapToOptional()
 }

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

@@ -37,7 +37,7 @@ internal class DownloadTask private constructor(val metadata: IndexFile.File, va
 
 	fun isNewOptional() = isOptional && newOptional
 
-	fun correctSide() = metadata.linkedFile?.side?.hasSide(downloadSide) ?: true
+	fun correctSide() = metadata.linkedFile?.side?.let { downloadSide.hasSide(it) } ?: true
 
 	override val name get() = metadata.name
 
@@ -109,9 +109,9 @@ internal class DownloadTask private constructor(val metadata: IndexFile.File, va
 							cachedFile.optionValue = linkedFile.option.defaultValue
 						}
 					}
-					cachedFile.isOptional = isOptional
-					cachedFile.onlyOtherSide = !correctSide()
 				}
+				cachedFile.isOptional = isOptional
+				cachedFile.onlyOtherSide = !correctSide()
 			}
 		}
 	}

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

@@ -50,7 +50,20 @@ class LauncherUtils internal constructor(private val opts: UpdateManager.Options
 			"net.minecraftforge" to "forge",
 			"net.fabricmc.fabric-loader" to "fabric",
 			"org.quiltmc.quilt-loader" to "quilt",
-			"com.mumfrey.liteloader" to "liteloader")
+			"com.mumfrey.liteloader" to "liteloader"
+		)
+		// MultiMC requires components to be sorted; this is defined in the MultiMC meta repo, but they seem to
+		// be the same for every version so they are just used directly here
+		val componentOrders = mapOf(
+			"net.minecraft" to -2,
+			"org.lwjgl" to -1,
+			"org.lwjgl3" to -1,
+			"net.minecraftforge" to 5,
+			"net.fabricmc.fabric-loader" to 10,
+			"org.quiltmc.quilt-loader" to 10,
+			"com.mumfrey.liteloader" to 10,
+			"net.fabricmc.intermediary" to 11
+		)
 		val modLoadersClasses = modLoaders.entries.associate{(k,v)-> v to k}
 		val loaderVersionsFound = HashMap<String, String?>()
 		val outdatedLoaders = mutableSetOf<String>()
@@ -92,6 +105,15 @@ class LauncherUtils internal constructor(private val opts: UpdateManager.Options
 		}
 
 		if (manifestModified) {
+			// Sort manifest by component order
+			val sortedComponents = components.sortedWith(nullsLast(compareBy {
+				if (it.isJsonObject) {
+					componentOrders[it.asJsonObject["uid"]?.asString]
+				} else { null }
+			}))
+			components.removeAll { true }
+			sortedComponents.forEach { components.add(it) }
+
 			// The manifest has been modified, so before saving it we'll ask the user
 			// if they wanna update it, continue without updating it, or exit
 			val oldVers = loaderVersionsFound.map { Pair(it.key, it.value) }

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

@@ -101,12 +101,15 @@ class Main(args: Array<String>) {
 			cmd.getOptionValue("multimc-folder")?.let{ PackwizFilePath(it.toPath()) } ?: PackwizFilePath("..".toPath())
 		}
 		val manifestFile = ui.wrap("Invalid manifest file path") {
-			packFolder / (cmd.getOptionValue("meta-file") ?: "manifest.json")
+			packFolder / (cmd.getOptionValue("meta-file") ?: "packwiz.json")
+		}
+		val timeout = ui.wrap("Invalid timeout value") {
+			cmd.getOptionValue("timeout")?.toLong() ?: 10
 		}
 
 		// Start update process!
 		try {
-			UpdateManager(UpdateManager.Options(packFile, manifestFile, packFolder, multimcFolder, side), ui)
+			UpdateManager(UpdateManager.Options(packFile, manifestFile, packFolder, multimcFolder, side, timeout), ui)
 		} catch (e: Exception) {
 			ui.showErrorAndExit("Update process failed", e)
 		}
@@ -123,6 +126,7 @@ class Main(args: Array<String>) {
 			options.addOption(null, "pack-folder", true, "Folder to install the pack to (defaults to the JAR directory)")
 			options.addOption(null, "multimc-folder", true, "The MultiMC pack folder (defaults to the parent of the pack directory)")
 			options.addOption(null, "meta-file", true, "JSON file to store pack metadata, relative to the pack folder (defaults to packwiz.json)")
+			options.addOption("t", "timeout", true, "Seconds to wait before automatically launching when asking about optional mods (defaults to 10)")
 		}
 
 		// TODO: link these somehow so they're only defined once?
@@ -135,6 +139,12 @@ class Main(args: Array<String>) {
 			options.addOption("g", "no-gui", false, "Don't display a GUI to show update progress")
 			options.addOption("h", "help", false, "Display this message") // Implemented in packwiz-installer-bootstrap!
 		}
+
+		@JvmStatic
+		fun main(args: Array<String>) {
+			Log.info("packwiz-installer was started without packwiz-installer-bootstrap. Use the bootstrapper for automatic updates! (Disregard this message if you have your own update mechanism)")
+			Main(args)
+		}
 	}
 
 	// Actual main() is in RequiresBootstrap!

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
@@ -48,7 +47,8 @@ class UpdateManager internal constructor(private val opts: Options, val ui: IUse
 		val manifestFile: PackwizFilePath,
 		val packFolder: PackwizFilePath,
 		val multimcFolder: PackwizFilePath,
-		val side: Side
+		val side: Side,
+		val timeout: Long,
 	)
 
 	// TODO: make this return a value based on results?
@@ -157,7 +157,7 @@ class UpdateManager internal constructor(private val opts: Options, val ui: IUse
 			// todo: --force?
 			ui.submitProgress(InstallProgress("Modpack is already up to date!", 1, 1))
 			if (manifest.cachedFiles.any { it.value.isOptional }) {
-				ui.awaitOptionalButton(false)
+				ui.awaitOptionalButton(false, opts.timeout)
 			}
 			if (!ui.optionsButtonPressed) {
 				return
@@ -196,7 +196,7 @@ 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)
 		}
@@ -206,7 +206,7 @@ class UpdateManager internal constructor(private val opts: Options, val ui: IUse
 		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 }) {
-				ui.awaitOptionalButton(false)
+				ui.awaitOptionalButton(false, opts.timeout)
 			}
 			if (!ui.optionsButtonPressed) {
 				return
@@ -338,7 +338,7 @@ class UpdateManager internal constructor(private val opts: Options, val ui: IUse
 			if (!ui.optionsButtonPressed) {
 				// TODO: this is so ugly
 				ui.submitProgress(InstallProgress("Reconfigure optional mods?", 0,1))
-				ui.awaitOptionalButton(true)
+				ui.awaitOptionalButton(true, opts.timeout)
 				if (ui.cancelButtonPressed) {
 					showCancellationDialog()
 					return

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

@@ -97,6 +97,16 @@ 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) {
+		if (file.linkedFile != null) {
+			if (file.linkedFile!!.resolvedUpdateData["curseforge"] == null) {
+				manualDownloadMods[(file.linkedFile!!.update["curseforge"] as CurseForgeUpdateData).projectId] = Pair(file, fileId)
+			}
+		}
+	}
+
 	if (manualDownloadMods.isNotEmpty()) {
 		val reqModsData = GetModsRequest(manualDownloadMods.keys.toList())
 		val reqMods = Request.Builder()

src/main/kotlin/link/infra/packwiz/installer/metadata/hash/Hash.kt

@@ -21,7 +21,14 @@ data class Hash<T>(val type: HashFormat<T>, val value: T) {
 
 		object UInt: Encoding<kotlin.UInt> {
 			override fun encodeToString(value: kotlin.UInt) = value.toString()
-			override fun decodeFromString(str: String) = str.toUInt()
+			override fun decodeFromString(str: String) =
+				try {
+					str.toUInt()
+				} catch (e: NumberFormatException) {
+					// Old packwiz.json values are signed; if they are negative they should be parsed as signed integers
+					// and reinterpreted as unsigned integers
+					str.toInt().toUInt()
+				}
 		}
 	}
 

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

@@ -8,9 +8,12 @@ import java.net.SocketTimeoutException
 import java.util.concurrent.TimeUnit
 
 class ClientHolder {
+	// Tries 10s timeouts (default), then 15s timeouts, then 60s timeouts
+	private val retryTimes = arrayOf(15, 60)
+
 	// TODO: a button to increase timeouts temporarily when retrying? manual retry button?
 	val okHttpClient by lazy { OkHttpClient.Builder()
-		// Retry requests up to 3 times, increasing the timeouts slightly if it failed
+		// Retry requests according to retryTimes list
 		.addInterceptor {
 			val req = it.request()
 
@@ -24,20 +27,20 @@ class ClientHolder {
 			}
 
 			var tryCount = 0
-			while (res == null && tryCount < 3) {
+			while (res == null && tryCount < retryTimes.size) {
-				tryCount++
+				Log.info("OkHttp connection to ${req.url} timed out; retrying... (${tryCount + 1}/${retryTimes.size})")
-
-				Log.info("OkHttp connection to ${req.url} timed out; retrying... ($tryCount/3)")
 
 				val longerTimeoutChain = it
-					.withConnectTimeout(10 * tryCount, TimeUnit.SECONDS)
+					.withConnectTimeout(retryTimes[tryCount], TimeUnit.SECONDS)
-					.withReadTimeout(10 * tryCount, TimeUnit.SECONDS)
+					.withReadTimeout(retryTimes[tryCount], TimeUnit.SECONDS)
-					.withWriteTimeout(10 * tryCount, TimeUnit.SECONDS)
+					.withWriteTimeout(retryTimes[tryCount], TimeUnit.SECONDS)
 				try {
 					res = longerTimeoutChain.proceed(req)
 				} catch (e: SocketTimeoutException) {
 					lastException = e
 				}
+
+				tryCount++
 			}
 
 			res ?: throw lastException!!

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 {
+	open fun hasSide(tSide: Side): Boolean {
-		if (this == tSide) {
+		return this == tSide || tSide == BOTH
-			return true
-		}
-		if (depSides != null) {
-			for (depSide in depSides) {
-				if (depSide == tSide) {
-					return true
-				}
-			}
-		}
-		return false
 	}
 
 	companion object {

src/main/kotlin/link/infra/packwiz/installer/target/path/PackwizPath.kt

@@ -43,9 +43,11 @@ abstract class PackwizPath<T: PackwizPath<T>>(path: String? = null) {
 				} else {
 					canonicalised += componentNorm
 					// Don't allow volume letters (allows traversal to the root on Windows)
-					if (componentNorm[0] in 'a'..'z' || componentNorm[0] in 'A'..'Z') {
+					if (componentNorm.length == 2) {
-						if (componentNorm[1] == ':') {
+						if (componentNorm[0] in 'a'..'z' || componentNorm[0] in 'A'..'Z') {
-							throw RequestException.Validation.PathContainsVolumeLetter(path)
+							if (componentNorm[1] == ':') {
+								throw RequestException.Validation.PathContainsVolumeLetter(path)
+							}
 						}
 					}
 				}

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

@@ -25,7 +25,7 @@ interface IUserInterface {
 
 	fun showUpdateConfirmationDialog(oldVersions: List<Pair<String, String?>>, newVersions: List<Pair<String, String?>>): UpdateConfirmationResult = UpdateConfirmationResult.CANCELLED
 
-	fun awaitOptionalButton(showCancel: Boolean)
+	fun awaitOptionalButton(showCancel: Boolean, timeout: Long)
 
 	enum class ExceptionListResult {
 		CONTINUE, CANCEL, IGNORE

src/main/kotlin/link/infra/packwiz/installer/ui/cli/CLIHandler.kt

@@ -63,7 +63,7 @@ class CLIHandler : IUserInterface {
 		return ExceptionListResult.CANCEL
 	}
 
-	override fun awaitOptionalButton(showCancel: Boolean) {
+	override fun awaitOptionalButton(showCancel: Boolean, timeout: Long) {
 		// Do nothing
 	}
 }

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

@@ -7,11 +7,13 @@ import link.infra.packwiz.installer.ui.data.IOptionDetails
 import link.infra.packwiz.installer.ui.data.InstallProgress
 import link.infra.packwiz.installer.util.Log
 import java.awt.EventQueue
+import java.util.Timer
 import java.util.concurrent.CompletableFuture
 import java.util.concurrent.CountDownLatch
 import javax.swing.JDialog
 import javax.swing.JOptionPane
 import javax.swing.UIManager
+import kotlin.concurrent.timer
 import kotlin.system.exitProcess
 
 class GUIHandler : IUserInterface {
@@ -220,12 +222,28 @@ class GUIHandler : IUserInterface {
 		return future.get()
 	}
 
-	override fun awaitOptionalButton(showCancel: Boolean) {
+	override fun awaitOptionalButton(showCancel: Boolean, timeout: Long) {
 		EventQueue.invokeAndWait {
 			frmPackwizlauncher.showOk(!showCancel)
 		}
 		visibleCountdownLatch.await()
+
+		var closeTimer: Timer? = null
+		if (timeout >= 0) {
+			var count = 0
+			closeTimer = timer("timeout", true, 0, 1000) {
+				if (count >= timeout) {
+					optionalSelectedLatch.countDown()
+					cancel()
+				} else {
+					frmPackwizlauncher.timeoutOk(timeout - count)
+					count += 1
+				}
+			};
+		}
+
 		optionalSelectedLatch.await()
+		closeTimer?.cancel()
 		EventQueue.invokeLater {
 			frmPackwizlauncher.hideOk()
 		}

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

@@ -121,4 +121,8 @@ class InstallWindow(private val handler: GUIHandler) : JFrame() {
 		}
 		buttonsPanel.revalidate()
 	}
+
+	fun timeoutOk(remaining: Long) {
+		btnOk.text = "Continue ($remaining)"
+	}
 }