Allow editing submission data

Author: TheEpicBlock

botfest/src/main/kotlin/net/modfest/botfest/App.kt

@@ -51,6 +51,7 @@ suspend fun main() {
 			add(::UserCommands)
 			add(::EventCommands)
 			add(::RoleManager)
+			add(::SubmissionCommands)
 		}
 
 		errorResponse { message, type ->

botfest/src/main/kotlin/net/modfest/botfest/Platform.kt

@@ -19,6 +19,7 @@ import net.modfest.platform.pojo.EventData
 import net.modfest.platform.pojo.HealthData
 import net.modfest.platform.pojo.PlatformErrorResponse
 import net.modfest.platform.pojo.SubmissionData
+import net.modfest.platform.pojo.SubmissionPatchData
 import net.modfest.platform.pojo.SubmitRequest
 import net.modfest.platform.pojo.UserCreateData
 import net.modfest.platform.pojo.UserData
@@ -106,6 +107,10 @@ class Platform(baseUrl: String) {
 		return getEvents().map { e -> e.id }
 	}
 
+	suspend fun getUserSubmissions(user: Snowflake): List<SubmissionData> {
+		return client.get("/user/dc:${user.value}/submissions").unwrapErrors().body()
+	}
+
 	/**
 	 * Retrieve a user by their discord id. Will be null if the user does not exist
 	 */
@@ -171,6 +176,13 @@ class PlatformAuthenticated(var client: HttpClient, var discordUser: Snowflake)
 		}.unwrapErrors().body()
 	}
 
+	suspend fun editSubmissionData(eventId: String, subId: String, edit: SubmissionPatchData) {
+		client.patch("/event/$eventId/submission/$subId") {
+			addAuth()
+			setBody(edit)
+		}
+	}
+
 	suspend fun registerMe(event: EventData) {
 		client.put("/event/"+event.id+"/registrations/dc:"+discordUser.value) {
 			addAuth()

botfest/src/main/kotlin/net/modfest/botfest/extensions/DebugCommands.kt

@@ -28,7 +28,7 @@ class DebugCommands : Extension(), KordExKoinComponent {
 			name = Translations.Commands.Group.Debug.name
 			description = Translations.Commands.Group.Debug.description
 
-			guild(MAIN_GUILD_ID)  // Otherwise it will take up to an hour to update
+			guild(MAIN_GUILD_ID) // Otherwise it will take up to an hour to update
 
 			// View health of the bot and platform
 			ephemeralSubCommand {

botfest/src/main/kotlin/net/modfest/botfest/extensions/EventCommands.kt

@@ -31,12 +31,11 @@ class EventCommands : Extension(), KordExKoinComponent {
 
 	@OptIn(UnsafeAPI::class)
 	override suspend fun setup() {
-		val platform = bot.getKoin().get<Platform>()
-
 		// Register command
 		unsafeSlashCommand {
 			name = Translations.Commands.Register.name
 			description = Translations.Commands.Register.description
+			guild(MAIN_GUILD_ID)
 
 			// We're using KordEx's unsafe api here, because our modal is optional and has prefilled fields.
 			// This means we're responsible for initiating the response

botfest/src/main/kotlin/net/modfest/botfest/extensions/SubmissionCommands.kt

@@ -0,0 +1,171 @@
+package net.modfest.botfest.extensions
+
+import dev.kord.core.behavior.interaction.response.edit
+import dev.kordex.core.commands.Arguments
+import dev.kordex.core.commands.converters.impl.string
+import dev.kordex.core.components.forms.ModalForm
+import dev.kordex.core.extensions.Extension
+import dev.kordex.core.extensions.ephemeralSlashCommand
+import dev.kordex.core.i18n.toKey
+import dev.kordex.core.i18n.types.Key
+import dev.kordex.core.i18n.withContext
+import dev.kordex.core.koin.KordExKoinComponent
+import dev.kordex.core.utils.suggestStringCollection
+import dev.kordex.modules.dev.unsafe.annotations.UnsafeAPI
+import dev.kordex.modules.dev.unsafe.commands.slash.InitialSlashCommandResponse
+import dev.kordex.modules.dev.unsafe.extensions.unsafeSubCommand
+import net.modfest.botfest.MAIN_GUILD_ID
+import net.modfest.botfest.Platform
+import net.modfest.botfest.i18n.Translations
+import net.modfest.platform.pojo.SubmissionData.AssociatedData.Other
+import net.modfest.platform.pojo.SubmissionPatchData
+import org.koin.core.component.inject
+import java.util.*
+
+/**
+ * Provides various debugging commands
+ */
+class SubmissionCommands : Extension(), KordExKoinComponent {
+	override val name = "submission"
+	val platform: Platform by inject()
+
+	@OptIn(UnsafeAPI::class)
+	override suspend fun setup() {
+		ephemeralSlashCommand {
+			name = Translations.Commands.Group.Submission.name
+			description = Translations.Commands.Group.Submission.description
+
+			guild(MAIN_GUILD_ID)
+
+			unsafeSubCommand(::SubmissionArg) {
+				name = Translations.Commands.Submission.Edit.name
+				description = Translations.Commands.Submission.Edit.description
+
+				initialResponse = InitialSlashCommandResponse.None
+
+				action {
+					val subId = this.arguments.submission
+					val curEvent = platform.getCurrentEvent().event
+					if (curEvent == null) {
+						ackEphemeral {
+							content = Translations.Commands.Event.Submit.Response.unavailable
+								.withContext(this@action)
+								.translateNamed()
+						}
+						return@action
+					}
+
+					val submission = platform.getUserSubmissions(this.user.id).find { it.id == subId }
+
+					if (submission == null) {
+						ackEphemeral {
+							content = Translations.Commands.Submission.Edit.Response.notfound
+								.withContext(this@action)
+								.translateNamed(
+									"subId" to subId
+								)
+						}
+						return@action
+					}
+
+					val subPlatformData = submission.platform.inner
+					val modal: SubmissionEditForm
+					if (subPlatformData is Other) {
+						modal = SubmissionEditOtherForm()
+						if (subPlatformData.homepageUrl != null) {
+							modal.homepage.initialValue = subPlatformData.homepageUrl!!.toKey(Locale.UK)
+						}
+					} else {
+						modal = SubmissionEditForm()
+					}
+					modal.name.initialValue = submission.name.toKey(Locale.UK)
+					modal.description.initialValue = submission.description.toKey(Locale.UK)
+					if (submission.source != null) {
+						modal.source.initialValue = submission.source!!.toKey(Locale.UK)
+					}
+
+					val result = modal.sendAndDeferEphemeral(this)
+
+					// Result will be null if the user didn't enter anything
+					// or if the modal timed out
+					if (result == null) {
+						return@action
+					}
+
+					platform.withAuth(this.user).editSubmissionData(curEvent, subId, SubmissionPatchData(
+						modal.name.value,
+						modal.description.value,
+						modal.source.value,
+						if (modal is SubmissionEditOtherForm) { modal.homepage.value } else { null }
+					))
+
+					result.edit {
+						content = Translations.Commands.Submission.Edit.Response.success
+							.withContext(this@action)
+							.translateNamed(
+								"subId" to subId
+							)
+					}
+				}
+			}
+		}
+	}
+
+	inner class SubmissionArg : Arguments() {
+		val submission by string {
+			name = Translations.Arguments.Submission.Edit.name
+			description = Translations.Arguments.Submission.Edit.description
+
+			autoComplete {
+				val curEvent = platform.getCurrentEvent().event ?: return@autoComplete
+				suggestStringCollection(
+					platform.getUserSubmissions(this.user.id)
+						.filter { it.event == curEvent }
+						.map { it.id }
+				)
+			}
+		}
+	}
+
+	open class SubmissionEditForm : ModalForm() {
+		override var title: Key = Translations.Modal.Submission.Edit.title
+
+		val name = lineText {
+			label = Translations.Modal.Submission.Name.label
+			placeholder = Translations.Modal.Submission.Name.placeholder
+			minLength = 2
+			maxLength = 128
+			required = true
+			translateInitialValue = false
+		}
+
+		val description = lineText {
+			label = Translations.Modal.Submission.Description.label
+			placeholder = Translations.Modal.Submission.Description.placeholder
+			minLength = 1
+			maxLength = 128
+			required = true
+			translateInitialValue = false
+		}
+
+		val source = lineText {
+			label = Translations.Modal.Submission.Source.label
+			placeholder = Translations.Modal.Submission.Source.placeholder
+			minLength = 0
+			maxLength = 128
+			required = false
+			translateInitialValue = false
+		}
+	}
+
+	class SubmissionEditOtherForm : SubmissionEditForm() {
+		val homepage = lineText {
+			label = Translations.Modal.Submission.Homepage.label
+			placeholder = Translations.Modal.Submission.Homepage.placeholder
+			minLength = 1
+			maxLength = 128
+			required = true
+			translateInitialValue = false
+		}
+	}
+}

botfest/src/main/resources/translations/botfest/strings.properties

@@ -6,6 +6,8 @@ commands.group.user.name=user
 commands.group.user.description=Manage your ModFest profile
 commands.group.event.name=event
 commands.group.event.description=Do things related to the current event
+commands.group.submission.name=submission
+commands.group.submission.description=Manage your submissions to the current event
 
 commands.getcurrentevent.name=GetCurrentEvent
 commands.getcurrentevent.description=Gets the current event
@@ -56,6 +58,10 @@ commands.event.submit.description=submit your mod
 commands.event.submit.response.invalid=`{url}` is not a valid Modrinth URL
 commands.event.submit.response.unavailable=There's no current event happening.
 commands.event.submit.response.success=Successfully submitted {mod} to {event} :tada:
+commands.submission.edit.name=edit
+commands.submission.edit.description=Edit your submission's data
+commands.submission.edit.response.notfound=Unknown submission {subId}
+commands.submission.edit.response.success=Successfully edited the data for {subId}
 
 commands.fix.name=fixmyroles
 commands.fix.description=Corrects any errors with your roles. Use after re-joining the server
@@ -75,6 +81,8 @@ arguments.setuser.pronouns.name=pronouns
 arguments.setuser.pronouns.description=Change your pronouns
 arguments.setuser.name.name=name
 arguments.setuser.name.description=Change your name
+arguments.submission.edit.name=submission
+arguments.submission.edit.description=The submission you want to edit
 
 modal.register.title=Register for ModFest
 modal.register.name.label=What name would you like on your profile?
@@ -86,6 +94,15 @@ modal.register.pronouns.placeholder=they/them
 modal.submit.title=Submit a mod
 modal.submit.url.label=Enter your project's Modrinth URL
 modal.submit.url.placeholder=https://modrinth.com/mod/your-mod
+modal.submission.edit.title=Edit your mod's data
+modal.submission.name.label=Name
+modal.submission.name.placeholder=...
+modal.submission.description.label=Description
+modal.submission.description.placeholder=...
+modal.submission.source.label=Sourcecode link
+modal.submission.source.placeholder=...
+modal.submission.homepage.label=Link to your project's homepage
+modal.submission.homepage.placeholder=https://mymod.com/
 
 apierror.event_no_exists=An event named {n} doesn't exists
 apierror.user_no_exists=A user named {n} doesn't exists

common/src/main/java/net/modfest/platform/pojo/SubmissionData.java

@@ -1,12 +1,14 @@
 package net.modfest.platform.pojo;
 
 import com.google.gson.*;
+import lombok.With;
 import org.jspecify.annotations.NonNull;
 import org.jspecify.annotations.Nullable;
 
 import java.lang.reflect.Type;
 import java.util.Set;
 
+@With
 public record SubmissionData(@NonNull String id,
 							 @NonNull String event,
 							 @NonNull String name,
@@ -36,6 +38,7 @@ public record Modrinth(String projectId, @Nullable String versionId) {
 			public static final String KEY = "modrinth";
 		}
 
+		@With
 		public record Other(@Nullable String homepageUrl, @Nullable String downloadUrl) {
 			public static final String KEY = "other";
 		}

common/src/main/java/net/modfest/platform/pojo/SubmissionPatchData.java

@@ -0,0 +1,14 @@
+package net.modfest.platform.pojo;
+
+import org.jspecify.annotations.Nullable;
+
+public record SubmissionPatchData(
+	@Nullable String name,
+	@Nullable String description,
+	@Nullable String sourceUrl,
+	/**
+	 * Should not be included if the submission isn't of type "other"
+	 */
+	@Nullable String homepage
+) {
+}

platform_api/src/main/java/net/modfest/platform/controller/EventController.java

@@ -2,6 +2,7 @@
 
 import net.modfest.platform.pojo.EventData;
 import net.modfest.platform.pojo.SubmissionData;
+import net.modfest.platform.pojo.SubmissionPatchData;
 import net.modfest.platform.pojo.SubmitRequest;
 import net.modfest.platform.security.PermissionUtils;
 import net.modfest.platform.security.Permissions;
@@ -112,4 +113,21 @@ public SubmissionData makeSubmission(@PathVariable String eventId, @RequestBody
 
 		return service.makeModrinthSubmission(eventId, submission.modrinthProject());
 	}
+
+	@PatchMapping("/event/{eventId}/submission/{subId}")
+	public void editSubmissionData(@PathVariable String eventId, @PathVariable String subId, @RequestBody SubmissionPatchData editData) {
+		getEvent(eventId);
+		var subject = SecurityUtils.getSubject();
+		var can_others = subject.isPermitted(Permissions.Event.EDIT_OTHER_SUBMISSION);
+		var submission = service.getSubmission(eventId, subId);
+		if (submission == null) {
+			throw new IllegalArgumentException();// TODO
+		}
+		if (!PermissionUtils.owns(subject, submission) && !can_others) {
+			throw new ResponseStatusException(HttpStatus.FORBIDDEN,
+				"You do not have permissions to edit this data");
+		}
+
+		service.editSubmission(submission, editData);
+	}
 }

platform_api/src/main/java/net/modfest/platform/security/PermissionGroup.java

@@ -18,7 +18,8 @@ public enum PermissionGroup {
 		Permissions.Event.REGISTER_OTHERS,
 		Permissions.Event.SUBMIT_BYPASS,
 		Permissions.Event.SUBMIT_OTHER,
-		Permissions.Event.EDIT_SCHEDULE
+		Permissions.Event.EDIT_SCHEDULE,
+		Permissions.Event.EDIT_OTHER_SUBMISSION
 	)),
 	/**
 	 * Note: BotFest usually performs actions on behalf of a different user.