aboutsummaryrefslogtreecommitdiff
path: root/src/main/kotlin
diff options
context:
space:
mode:
authorRoman / Linnea Gräf <roman.graef@gmail.com>2023-07-21 09:28:48 +0200
committerGitHub <noreply@github.com>2023-07-21 09:28:48 +0200
commit34835697e889799e2b4e97c3bbf0ea73c04d5a64 (patch)
tree421de44a9dcff26b44bab18fcde9ed89ef066f28 /src/main/kotlin
parent3184880b31e9dc8d8985411468112c6b49e5b480 (diff)
downloadNotEnoughUpdates-34835697e889799e2b4e97c3bbf0ea73c04d5a64.tar.gz
NotEnoughUpdates-34835697e889799e2b4e97c3bbf0ea73c04d5a64.tar.bz2
NotEnoughUpdates-34835697e889799e2b4e97c3bbf0ea73c04d5a64.zip
Use ursa-minor as API proxy (#762)
* Use ursa-minor as API proxy * Allow setting a ursa server url * Make client aware of x-ursa-expires * Make profile data syncer work using legacy api * Add better header support * Add manual call functionality * Improve callUrsa to allow for raw strings * Save tokens better and add logs on http failure status codes * Remove API key requirement for PV * Make museum in pv also use ursa
Diffstat (limited to 'src/main/kotlin')
-rw-r--r--src/main/kotlin/io/github/moulberry/notenoughupdates/commands/dev/DevTestCommand.kt16
-rw-r--r--src/main/kotlin/io/github/moulberry/notenoughupdates/commands/misc/ProfileViewerCommands.kt7
-rw-r--r--src/main/kotlin/io/github/moulberry/notenoughupdates/util/HttpStatusCodeException.kt28
-rw-r--r--src/main/kotlin/io/github/moulberry/notenoughupdates/util/UrsaClient.kt201
-rw-r--r--src/main/kotlin/io/github/moulberry/notenoughupdates/util/hypixelapi/Collection.kt2
-rw-r--r--src/main/kotlin/io/github/moulberry/notenoughupdates/util/kotlin/Coroutines.kt20
6 files changed, 265 insertions, 9 deletions
diff --git a/src/main/kotlin/io/github/moulberry/notenoughupdates/commands/dev/DevTestCommand.kt b/src/main/kotlin/io/github/moulberry/notenoughupdates/commands/dev/DevTestCommand.kt
index e72a1ed4..8ad765eb 100644
--- a/src/main/kotlin/io/github/moulberry/notenoughupdates/commands/dev/DevTestCommand.kt
+++ b/src/main/kotlin/io/github/moulberry/notenoughupdates/commands/dev/DevTestCommand.kt
@@ -19,7 +19,9 @@
package io.github.moulberry.notenoughupdates.commands.dev
+import com.google.gson.JsonObject
import com.mojang.brigadier.arguments.StringArgumentType
+import com.mojang.brigadier.arguments.StringArgumentType.string
import io.github.moulberry.notenoughupdates.BuildFlags
import io.github.moulberry.notenoughupdates.NotEnoughUpdates
import io.github.moulberry.notenoughupdates.autosubscribe.NEUAutoSubscribe
@@ -36,7 +38,6 @@ import io.github.moulberry.notenoughupdates.util.brigadier.*
import net.minecraft.client.Minecraft
import net.minecraft.client.gui.GuiScreen
import net.minecraft.command.ICommandSender
-import net.minecraft.entity.item.EntityArmorStand
import net.minecraft.entity.player.EntityPlayer
import net.minecraft.launchwrapper.Launch
import net.minecraft.util.ChatComponentText
@@ -200,6 +201,16 @@ class DevTestCommand {
}
}
}
+ thenLiteral("callUrsa") {
+ thenArgument("path", RestArgumentType) { path ->
+ thenExecute {
+ NotEnoughUpdates.INSTANCE.manager.ursaClient.getString(this[path])
+ .thenAccept {
+ reply(it.toString())
+ }
+ }
+ }.withHelp("Send an authenticated request to the current ursa server")
+ }
thenLiteralExecute("dev") {
NotEnoughUpdates.INSTANCE.config.hidden.dev = !NotEnoughUpdates.INSTANCE.config.hidden.dev
reply("Dev mode " + if (NotEnoughUpdates.INSTANCE.config.hidden.dev) "§aenabled" else "§cdisabled")
@@ -210,7 +221,8 @@ class DevTestCommand {
}.withHelp("Force sync the config to disk")
thenLiteralExecute("clearapicache") {
ApiCache.clear()
- reply("Cleared API cache")
+ NotEnoughUpdates.INSTANCE.manager.ursaClient.clearToken()
+ reply("Cleared API cache and reset ursa token")
}.withHelp("Clear the API cache")
thenLiteralExecute("searchmode") {
NotEnoughUpdates.INSTANCE.config.hidden.firstTimeSearchFocus = true
diff --git a/src/main/kotlin/io/github/moulberry/notenoughupdates/commands/misc/ProfileViewerCommands.kt b/src/main/kotlin/io/github/moulberry/notenoughupdates/commands/misc/ProfileViewerCommands.kt
index d25e880b..fac673b4 100644
--- a/src/main/kotlin/io/github/moulberry/notenoughupdates/commands/misc/ProfileViewerCommands.kt
+++ b/src/main/kotlin/io/github/moulberry/notenoughupdates/commands/misc/ProfileViewerCommands.kt
@@ -45,16 +45,11 @@ class ProfileViewerCommands {
reply("${RED}Some parts of the profile viewer do not work with OptiFine Fast Render. Go to ESC > Options > Video Settings > Performance > Fast Render to disable it.")
}
- if (NotEnoughUpdates.INSTANCE.config.apiData.apiKey.isNullOrBlank()) {
- reply("${RED}Can't view profile, an API key is not set. Run /api new and put the result in settings.")
- return
- }
-
NotEnoughUpdates.profileViewer.loadPlayerByName(
name ?: Minecraft.getMinecraft().thePlayer.name
) { profile ->
if (profile == null) {
- reply("${RED}Invalid player name/API key. Maybe the API is down? Try /api new.")
+ reply("${RED}Invalid player name. Maybe the API is down? Try again later.")
} else {
profile.resetCache()
ProfileViewerUtils.saveSearch(name)
diff --git a/src/main/kotlin/io/github/moulberry/notenoughupdates/util/HttpStatusCodeException.kt b/src/main/kotlin/io/github/moulberry/notenoughupdates/util/HttpStatusCodeException.kt
new file mode 100644
index 00000000..bd38706f
--- /dev/null
+++ b/src/main/kotlin/io/github/moulberry/notenoughupdates/util/HttpStatusCodeException.kt
@@ -0,0 +1,28 @@
+/*
+ * Copyright (C) 2023 NotEnoughUpdates contributors
+ *
+ * This file is part of NotEnoughUpdates.
+ *
+ * NotEnoughUpdates is free software: you can redistribute it
+ * and/or modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * NotEnoughUpdates is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with NotEnoughUpdates. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package io.github.moulberry.notenoughupdates.util
+
+import java.net.URL
+
+data class HttpStatusCodeException(
+ val url: URL,
+ val statusCode: Int,
+ val serverMessage: String,
+) : RuntimeException("Server returned HTTP Status Code: $statusCode:\n$serverMessage")
diff --git a/src/main/kotlin/io/github/moulberry/notenoughupdates/util/UrsaClient.kt b/src/main/kotlin/io/github/moulberry/notenoughupdates/util/UrsaClient.kt
new file mode 100644
index 00000000..2320163d
--- /dev/null
+++ b/src/main/kotlin/io/github/moulberry/notenoughupdates/util/UrsaClient.kt
@@ -0,0 +1,201 @@
+/*
+ * Copyright (C) 2023 NotEnoughUpdates contributors
+ *
+ * This file is part of NotEnoughUpdates.
+ *
+ * NotEnoughUpdates is free software: you can redistribute it
+ * and/or modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * NotEnoughUpdates is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with NotEnoughUpdates. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package io.github.moulberry.notenoughupdates.util
+
+import com.google.gson.JsonObject
+import io.github.moulberry.notenoughupdates.NotEnoughUpdates
+import io.github.moulberry.notenoughupdates.autosubscribe.NEUAutoSubscribe
+import io.github.moulberry.notenoughupdates.options.customtypes.NEUDebugFlag
+import io.github.moulberry.notenoughupdates.util.kotlin.Coroutines.await
+import io.github.moulberry.notenoughupdates.util.kotlin.Coroutines.continueOn
+import io.github.moulberry.notenoughupdates.util.kotlin.Coroutines.launchCoroutine
+import net.minecraft.client.Minecraft
+import net.minecraftforge.fml.common.eventhandler.SubscribeEvent
+import net.minecraftforge.fml.common.gameevent.TickEvent
+import java.time.Duration
+import java.time.Instant
+import java.util.*
+import java.util.concurrent.CompletableFuture
+import java.util.concurrent.ConcurrentLinkedQueue
+
+class UrsaClient(val apiUtil: ApiUtil) {
+ private data class Token(
+ val validUntil: Instant,
+ val token: String,
+ val obtainedFrom: String,
+ ) {
+ val isValid get() = Instant.now().plusSeconds(60) < validUntil
+ }
+
+ val logger = NEUDebugFlag.API_CACHE
+
+ // Needs synchronized access
+ private var token: Token? = null
+ private var isPollingForToken = false
+
+ private data class Request<T>(
+ val path: String,
+ val objectMapping: Class<T>?,
+ val consumer: CompletableFuture<T>,
+ )
+
+ private val queue = ConcurrentLinkedQueue<Request<*>>()
+ private val ursaRoot
+ get() = NotEnoughUpdates.INSTANCE.config.apiData.ursaApi.removeSuffix("/").takeIf { it.isNotBlank() }
+ ?: "https://ursa.notenoughupdates.org"
+
+ private suspend fun authorizeRequest(usedUrsaRoot: String, connection: ApiUtil.Request, t: Token?) {
+ if (t != null && t.obtainedFrom == usedUrsaRoot) {
+ logger.log("Authorizing request using token")
+ connection.header("x-ursa-token", t.token)
+ } else {
+ logger.log("Authorizing request using username and serverId")
+ val serverId = UUID.randomUUID().toString()
+ val session = Minecraft.getMinecraft().session
+ val name = session.username
+ connection.header("x-ursa-username", name).header("x-ursa-serverid", serverId)
+ continueOn(MinecraftExecutor.OffThread)
+ Minecraft.getMinecraft().sessionService.joinServer(session.profile, session.token, serverId)
+ logger.log("Authorizing request using username and serverId complete")
+ }
+ }
+
+ private suspend fun saveToken(usedUrsaRoot: String, connection: ApiUtil.Request) {
+ logger.log("Attempting to save token")
+ val token =
+ connection.responseHeaders["x-ursa-token"]?.firstOrNull()
+ val validUntil = connection.responseHeaders["x-ursa-expires"]
+ ?.firstOrNull()
+ ?.toLongOrNull()
+ ?.let { Instant.ofEpochMilli(it) } ?: (Instant.now() + Duration.ofMinutes(55))
+ continueOn(MinecraftExecutor.OnThread)
+ if (token == null) {
+ isPollingForToken = false
+ logger.log("No token found. Marking as non polling")
+ } else {
+ this.token = Token(validUntil, token, usedUrsaRoot)
+ isPollingForToken = false
+ logger.log("Token saving successful")
+ }
+ }
+
+ private suspend fun <T> performRequest(request: Request<T>, token: Token?) {
+ val usedUrsaRoot = ursaRoot
+ val apiRequest = apiUtil.request().url("$usedUrsaRoot/${request.path}")
+ try {
+ logger.log("Ursa Request started")
+ authorizeRequest(usedUrsaRoot, apiRequest, token)
+ val response =
+ if (request.objectMapping == null)
+ (apiRequest.requestString().await() as T)
+ else
+ (apiRequest.requestJson(request.objectMapping).await() as T)
+ logger.log("Request completed")
+ saveToken(usedUrsaRoot, apiRequest)
+ request.consumer.complete(response)
+ } catch (e: Exception) {
+ e.printStackTrace()
+ logger.log("Request failed")
+ continueOn(MinecraftExecutor.OnThread)
+ isPollingForToken = false
+ request.consumer.completeExceptionally(e)
+ }
+ }
+
+ private fun bumpRequests() {
+ while (!queue.isEmpty()) {
+ if (isPollingForToken) return
+ val nextRequest = queue.poll()
+ if (nextRequest == null) {
+ logger.log("No request to bump found")
+ return
+ }
+ logger.log("Request found")
+ var t = token
+ if (!(t != null && t.isValid && t.obtainedFrom == ursaRoot)) {
+ isPollingForToken = true
+ t = null
+ if (token != null) {
+ logger.log("Disposing old invalid ursa token.")
+ token = null
+ }
+ logger.log("No token saved. Marking this request as a token poll request")
+ }
+ launchCoroutine { performRequest(nextRequest, t) }
+ }
+ }
+
+
+ fun clearToken() {
+ synchronized(this) {
+ token = null
+ }
+ }
+
+ fun <T> get(path: String, clazz: Class<T>): CompletableFuture<T> {
+ val c = CompletableFuture<T>()
+ queue.add(Request(path, clazz, c))
+ return c
+ }
+
+
+ fun getString(path: String): CompletableFuture<String> {
+ val c = CompletableFuture<String>()
+ queue.add(Request(path, null, c))
+ return c
+ }
+
+ fun <T> get(knownRequest: KnownRequest<T>): CompletableFuture<T> {
+ return get(knownRequest.path, knownRequest.type)
+ }
+
+ data class KnownRequest<T>(val path: String, val type: Class<T>) {
+ fun <N> typed(newType: Class<N>) = KnownRequest(path, newType)
+ inline fun <reified N> typed() = typed(N::class.java)
+ }
+
+ @NEUAutoSubscribe
+ object TickHandler {
+ @SubscribeEvent
+ fun onTick(event: TickEvent) {
+ NotEnoughUpdates.INSTANCE.manager.ursaClient.bumpRequests()
+ }
+ }
+
+ companion object {
+ @JvmStatic
+ fun profiles(uuid: UUID) = KnownRequest("v1/hypixel/profiles/${uuid}", JsonObject::class.java)
+
+ @JvmStatic
+ fun player(uuid: UUID) = KnownRequest("v1/hypixel/player/${uuid}", JsonObject::class.java)
+
+ @JvmStatic
+ fun guild(uuid: UUID) = KnownRequest("v1/hypixel/guild/${uuid}", JsonObject::class.java)
+
+ @JvmStatic
+ fun bingo(uuid: UUID) = KnownRequest("v1/hypixel/bingo/${uuid}", JsonObject::class.java)
+
+ @JvmStatic
+ fun museumForProfile(profileUuid: String) = KnownRequest("v1/hypixel/museum/${profileUuid}", JsonObject::class.java)
+
+ @JvmStatic
+ fun status(uuid: UUID) = KnownRequest("v1/hypixel/status/${uuid}", JsonObject::class.java)
+ }
+}
diff --git a/src/main/kotlin/io/github/moulberry/notenoughupdates/util/hypixelapi/Collection.kt b/src/main/kotlin/io/github/moulberry/notenoughupdates/util/hypixelapi/Collection.kt
index b2c7fcec..e5c7263c 100644
--- a/src/main/kotlin/io/github/moulberry/notenoughupdates/util/hypixelapi/Collection.kt
+++ b/src/main/kotlin/io/github/moulberry/notenoughupdates/util/hypixelapi/Collection.kt
@@ -95,7 +95,7 @@ data class ProfileCollectionInfo(
val hypixelCollectionInfo: CompletableFuture<CollectionMetadata> by lazy {
NotEnoughUpdates.INSTANCE.manager.apiUtils
- .newHypixelApiRequest("resources/skyblock/collections")
+ .newAnonymousHypixelApiRequest("resources/skyblock/collections")
.requestJson()
.thenApply {
NotEnoughUpdates.INSTANCE.manager.gson.fromJson(it, CollectionMetadata::class.java)
diff --git a/src/main/kotlin/io/github/moulberry/notenoughupdates/util/kotlin/Coroutines.kt b/src/main/kotlin/io/github/moulberry/notenoughupdates/util/kotlin/Coroutines.kt
index 4bcf0c61..d84bf082 100644
--- a/src/main/kotlin/io/github/moulberry/notenoughupdates/util/kotlin/Coroutines.kt
+++ b/src/main/kotlin/io/github/moulberry/notenoughupdates/util/kotlin/Coroutines.kt
@@ -24,6 +24,7 @@ import net.minecraftforge.fml.common.eventhandler.SubscribeEvent
import net.minecraftforge.fml.common.gameevent.TickEvent
import java.util.concurrent.CompletableFuture
import java.util.concurrent.Executor
+import java.util.concurrent.ForkJoinPool
import kotlin.coroutines.*
@NEUAutoSubscribe
@@ -54,6 +55,13 @@ object Coroutines {
}
}
+ fun <T> launchCoroutine(block: suspend () -> T): CompletableFuture<T> {
+ return launchCoroutineOnCurrentThread {
+ continueOn(ForkJoinPool.commonPool())
+ block()
+ }
+ }
+
private data class DelayedTask(val contination: () -> Unit, var tickDelay: Int)
private val tasks = mutableListOf<DelayedTask>()
@@ -76,6 +84,18 @@ object Coroutines {
}
}
+
+ suspend fun <T> CompletableFuture<T>.await(): T {
+ return suspendCoroutine { cont ->
+ handle { res, ex ->
+ if (ex != null)
+ cont.resumeWithException(ex)
+ else
+ cont.resume(res)
+ }
+ }
+ }
+
suspend fun waitTicks(tickCount: Int) {
suspendCoroutine {
synchronized(tasks) {