Skip to content

Forms system #524

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

Forms system #524

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
a114e30
Forms system
Defective4 Sep 7, 2025
bdf0b1a
Store form fields in a separate table
Defective4 Sep 17, 2025
b62574d
Use default values for all `NOT NULL` fields
Defective4 Sep 17, 2025
2c97172
Store form's message channel and id as longs instead of Strings
Defective4 Sep 17, 2025
7db911a
Changed submissions table structure to use unique ids
Defective4 Sep 17, 2025
e2c6372
Correct `FormsRepository` javadoc
Defective4 Sep 17, 2025
7cb72ed
Adjustments to the `FormsRepository` class
Defective4 Sep 17, 2025
61d7e36
Fix javadoc spelling mistakes
Defective4 Sep 17, 2025
21d9a42
Make the `FormField` into a record
Defective4 Sep 17, 2025
3425fa0
Convert `FormData` into a record and use `Instants` for expiration
Defective4 Sep 18, 2025
fdd328e
Form field javadoc
Defective4 Sep 20, 2025
123282b
Convert `FormUser` to a `record`
Defective4 Sep 20, 2025
7fccf8e
`FormCommand` javadoc
Defective4 Sep 20, 2025
385820d
Fix checkstyle
Defective4 Sep 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions ...main/java/net/discordjug/javabot/systems/staff_commands/forms/FormInteractionManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,9 @@ public class FormInteractionManager implements ButtonHandler, ModalHandler {
public void closeForm(Guild guild, FormData form) {
formsRepo.closeForm(form);

if (form.getMessageChannel() != null && form.getMessageId() != null) {
TextChannel formChannel = guild.getTextChannelById(form.getMessageChannel());
formChannel.retrieveMessageById(form.getMessageId()).queue(msg -> {
if (form.isAttached()) {
TextChannel formChannel = guild.getTextChannelById(form.getMessageChannel().get());
formChannel.retrieveMessageById(form.getMessageId().get()).queue(msg -> {
mapFormMessageButtons(msg, btn -> {
String cptId = btn.getId();
String[] split = ComponentIdBuilder.split(cptId);
Expand Down Expand Up @@ -149,8 +149,9 @@ public void handleModal(ModalInteractionEvent event, List<ModalMapping> values)
return;
}

channel.sendMessageEmbeds(createSubmissionEmbed(form, values, event.getMember())).queue();
formsRepo.logSubmission(event.getUser(), form);
channel.sendMessageEmbeds(createSubmissionEmbed(form, values, event.getMember())).queue(msg -> {
formsRepo.addSubmission(event.getUser(), form, msg);
});

event.getHook()
Copy link
Member

@danthe1st danthe1st Sep 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both the submission and the confirmation should be sent only if the message has been sent successfully. If it hasn't, there should be an error message sent to the user saying there was an error with the submission and a log message.
My guess is that the most likely reason this could happen would be hitting the message character limit or similar.

.sendMessage(
Expand Down Expand Up @@ -190,9 +191,9 @@ public void mapFormMessageButtons(Message msg, Function<Button, Button> mapper)
public void reopenForm(Guild guild, FormData form) {
formsRepo.reopenForm(form);

if (form.getMessageChannel() != null && form.getMessageId() != null) {
TextChannel formChannel = guild.getTextChannelById(form.getMessageChannel());
formChannel.retrieveMessageById(form.getMessageId()).queue(msg -> {
if (form.isAttached()) {
TextChannel formChannel = guild.getTextChannelById(form.getMessageChannel().get());
formChannel.retrieveMessageById(form.getMessageId().get()).queue(msg -> {
mapFormMessageButtons(msg, btn -> {
String cptId = btn.getId();
String[] split = ComponentIdBuilder.split(cptId);
Expand Down Expand Up @@ -267,7 +268,7 @@ private static MessageEmbed createSubmissionEmbed(FormData form, List<ModalMappi
ModalMapping mapping = values.get(i);
FormField field = form.getFields().get(i);
String value = mapping.getAsString();
Copy link
Member

@danthe1st danthe1st Sep 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess you might want to replace markdown codeblocks with something like

` ` `

or truncate them - or generally prohibit that?

Copy link
Member Author

@Defective4 Defective4 Sep 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a good point, I'll definitely do that

builder.addField(field.getLabel(), value == null ? "*Empty*" : "```\n" + value + "\n```", false);
builder.addField(field.label(), value == null ? "*Empty*" : "```\n" + value + "\n```", false);
}

return builder.build();
Expand Down
13 changes: 3 additions & 10 deletions .../net/discordjug/javabot/systems/staff_commands/forms/commands/AddFieldFormSubcommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,7 @@ public AddFieldFormSubcommand(FormsRepository formsRepo) {
.addOption(OptionType.BOOLEAN, "required",
"Whether or not the user has to input data in this field. Default: false")
.addOption(OptionType.STRING, "style", "Input style. Default: SHORT", false, true)
Copy link
Member

@danthe1st danthe1st Sep 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think a choice option would be better than autocomplete for the style.

.addOption(OptionType.STRING, "value", "Initial field value")
.addOption(OptionType.INTEGER, "index", "Index to insert the field at"));
.addOption(OptionType.STRING, "value", "Initial field value"));
}

@Override
Expand All @@ -60,13 +59,7 @@ public void execute(SlashCommandInteractionEvent event) {
return;
}

int index = event.getOption("index", -1, OptionMapping::getAsInt);
if (index < -1 || index >= form.getFields().size()) {
event.getHook().sendMessage("Field index out of bounds").queue();
return;
}

formsRepo.addField(form, createFormFieldFromEvent(event), index);
formsRepo.addField(form, createFormFieldFromEvent(event));
event.getHook().sendMessage("Added a new field to the form.").queue();
}

Expand Down Expand Up @@ -98,6 +91,6 @@ private static FormField createFormFieldFromEvent(SlashCommandInteractionEvent e
});
String value = e.getOption("value", OptionMapping::getAsString);

return new FormField(label, max, min, placeholder, required, style.name(), value);
return new FormField(label, max, min, placeholder, required, style, value, 0);
}
}
2 changes: 1 addition & 1 deletion ...va/net/discordjug/javabot/systems/staff_commands/forms/commands/AttachFormSubcommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public void execute(SlashCommandInteractionEvent event) {
}
FormData form = formOpt.get();

if (form.getMessageChannel() != null && form.getMessageId() != null) {
if (form.isAttached()) {
event.getHook()
.sendMessage("The form seems to already be attached to a message. Detach it before continuing.")
.queue();
Expand Down
2 changes: 1 addition & 1 deletion ...va/net/discordjug/javabot/systems/staff_commands/forms/commands/CreateFormSubcommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ public void execute(SlashCommandInteractionEvent event) {

long formId = System.currentTimeMillis();
FormData form = new FormData(formId, List.of(), event.getOption("title", OptionMapping::getAsString),
event.getOption("submit-channel", OptionMapping::getAsChannel).getId(),
event.getOption("submit-channel", OptionMapping::getAsChannel).getIdLong(),
event.getOption("submit-message", null, OptionMapping::getAsString), null, null, expiration, false,
event.getOption("onetime", false, OptionMapping::getAsBoolean));

Expand Down
3 changes: 2 additions & 1 deletion ...va/net/discordjug/javabot/systems/staff_commands/forms/commands/DeleteFormSubcommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,9 @@ public void execute(SlashCommandInteractionEvent event) {
FormData form = formOpt.get();
formsRepo.deleteForm(form);

if (form.getMessageChannel() != null && form.getMessageId() != null) {
if (form.isAttached()) {
DetachFormSubcommand.detachFromMessage(form, event.getGuild());
Copy link
Member

@danthe1st danthe1st Sep 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think it's better to detach and delete a form automatically if it's attached or to show an error message to the user?
After all, it's possible that the person executing the command doesn't know about the form being attached.

Copy link
Member Author

@Defective4 Defective4 Sep 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a good point. I assumed the form should be detached automatically when the user deletes it.

// TODO send a warning
Copy link
Member

@danthe1st danthe1st Sep 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This TODO comment should be implemented before this PR is merged (and then you also wouldn't need the detaching here) ;)

Copy link
Member Author

@Defective4 Defective4 Sep 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, that's the plan.

}

event.getHook().sendMessage("Form deleted!").queue();
Expand Down
7 changes: 4 additions & 3 deletions ...va/net/discordjug/javabot/systems/staff_commands/forms/commands/DetachFormSubcommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public void execute(SlashCommandInteractionEvent event) {
}
FormData form = formOpt.get();

if (form.getMessageChannel() == null && form.getMessageId() == null) {
if (!form.isAttached()) {
event.getHook().sendMessage("This form doesn't seem to be attached to a message").queue();
return;
}
Expand All @@ -80,8 +80,9 @@ public void handleAutoComplete(CommandAutoCompleteInteractionEvent event, AutoCo
* @param guild guild this form is contained in
*/
public static void detachFromMessage(FormData form, Guild guild) {
TextChannel formChannel = guild.getTextChannelById(form.getMessageChannel());
formChannel.retrieveMessageById(form.getMessageId()).queue(msg -> {
if(!form.isAttached()) return;
TextChannel formChannel = guild.getTextChannelById(form.getMessageChannel().get());
formChannel.retrieveMessageById(form.getMessageId().get()).queue(msg -> {
List<ActionRow> components = msg.getActionRows().stream().map(row -> {
ItemComponent[] cpts = row.getComponents().stream().filter(cpt -> {
Copy link
Member

@danthe1st danthe1st Sep 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, I don't think there's a good reason to use arrays here.

if (cpt instanceof Button btn) {
Expand Down
7 changes: 3 additions & 4 deletions ...a/net/discordjug/javabot/systems/staff_commands/forms/commands/DetailsFormSubcommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,11 +80,10 @@ private EmbedBuilder createFormDetailsEmbed(FormData form, Guild guild) {
addCodeblockField(builder, "State", form.isClosed() ? "Closed" : form.hasExpired() ? "Expired" : "Open", false);

builder.addField("Attached in",
form.getMessageChannel() == null ? "*Not attached*" : "<#" + form.getMessageChannel() + ">", true);
form.isAttached() ? "<#" + form.getMessageChannel().get() + ">" : "*Not attached*", true);
builder.addField("Attached to",
form.getMessageChannel() == null || form.getMessageId() == null ? "*Not attached*"
: String.format("[Link](https://discord.com/channels/%s/%s/%s)", guild.getId(),
form.getMessageChannel(), form.getMessageId()),
form.isAttached() ? String.format("[Link](https://discord.com/channels/%s/%s/%s)", guild.getId(),
form.getMessageChannel().get(), form.getMessageId().get()) : "*Not attached*",
true);

builder.addField("Submissions channel", "<#" + form.getSubmitChannel() + ">", true);
Copy link
Member

@danthe1st danthe1st Sep 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, MessageChannel#getAsMention

Expand Down
6 changes: 3 additions & 3 deletions ...va/net/discordjug/javabot/systems/staff_commands/forms/commands/ModifyFormSubcommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,7 @@ public void execute(SlashCommandInteractionEvent event) {
FormData oldForm = formOpt.get();

String title = event.getOption("title", oldForm.getTitle(), OptionMapping::getAsString);
String submitChannel = event.getOption("submit-channel", oldForm.getSubmitChannel(),
OptionMapping::getAsString);
long submitChannel = event.getOption("submit-channel", oldForm.getSubmitChannel(), OptionMapping::getAsLong);
String submitMessage = event.getOption("submit-message", oldForm.getSubmitMessage(),
OptionMapping::getAsString);
long expiration;
Expand All @@ -72,7 +71,8 @@ public void execute(SlashCommandInteractionEvent event) {
boolean onetime = event.getOption("onetime", oldForm.isOnetime(), OptionMapping::getAsBoolean);

FormData newForm = new FormData(oldForm.getId(), oldForm.getFields(), title, submitChannel, submitMessage,
oldForm.getMessageId(), oldForm.getMessageChannel(), expiration, oldForm.isClosed(), onetime);
oldForm.getMessageId().orElse(null), oldForm.getMessageChannel().orElse(null), expiration,
oldForm.isClosed(), onetime);

formsRepo.updateForm(newForm);

Expand Down
6 changes: 3 additions & 3 deletions ...t/discordjug/javabot/systems/staff_commands/forms/commands/RemoveFieldFormSubcommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ public void execute(SlashCommandInteractionEvent event) {
return;
}

if (form.getMessageChannel() != null && form.getMessageId() != null && form.getFields().size() <= 1) {
if (form.isAttached() && form.getFields().size() <= 1) {
event.getHook().sendMessage(
"Can't remove the last field from an attached form. Detach the form before removing the field")
.queue();
Expand All @@ -61,7 +61,7 @@ public void execute(SlashCommandInteractionEvent event) {

formsRepo.removeField(form, index);

event.getHook().sendMessage("Removed field `" + form.getFields().get(index).getLabel() + "` from the form.")
event.getHook().sendMessage("Removed field `" + form.getFields().get(index).label() + "` from the form.")
.queue();
}

Expand All @@ -79,7 +79,7 @@ public void handleAutoComplete(CommandAutoCompleteInteractionEvent event, AutoCo
List<Choice> choices = new ArrayList<>();
List<FormField> fields = form.get().getFields();
for (int i = 0; i < fields.size(); i++) {
choices.add(new Choice(fields.get(i).getLabel(), i));
choices.add(new Choice(fields.get(i).label(), i));
}
event.replyChoices(choices).queue();
Copy link
Member

@danthe1st danthe1st Sep 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, reminder to use filterChoices.

return;
Expand Down
33 changes: 8 additions & 25 deletions ...ordjug/javabot/systems/staff_commands/forms/commands/SubmissionsDeleteFormSubcommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

import net.discordjug.javabot.systems.staff_commands.forms.dao.FormsRepository;
import net.discordjug.javabot.systems.staff_commands.forms.model.FormData;
import net.dv8tion.jda.api.entities.User;
import net.dv8tion.jda.api.events.interaction.command.CommandAutoCompleteInteractionEvent;
import net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent;
import net.dv8tion.jda.api.interactions.AutoCompleteQuery;
Expand All @@ -29,11 +30,9 @@ public class SubmissionsDeleteFormSubcommand extends Subcommand implements AutoC
*/
public SubmissionsDeleteFormSubcommand(FormsRepository formsRepo) {
this.formsRepo = formsRepo;
setCommandData(
new SubcommandData("submissions-delete", "Deletes submissions of an user in the form").addOptions(
new OptionData(OptionType.INTEGER, "form-id", "The ID of a form to get submissions for", true,
true),
new OptionData(OptionType.STRING, "user-id", "User to delete submissions of", true, true)));
setCommandData(new SubcommandData("submissions-delete", "Deletes submissions of a user in the form")
.addOptions(new OptionData(OptionType.INTEGER, "form-id", "The ID of a form to get submissions for",
Copy link
Member

@danthe1st danthe1st Sep 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

get submissions for is misleading.

Copy link
Member Author

@Defective4 Defective4 Sep 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, it's just another oversight of mine. I did a lot of copy-pasting when creating the commands, and it seems I forgot to change the parameter description here

true, true), new OptionData(OptionType.USER, "user", "User to delete submissions of", true)));
}

@Override
Expand All @@ -45,7 +44,7 @@ public void execute(SlashCommandInteractionEvent event) {
return;
}

String user = event.getOption("user-id", OptionMapping::getAsString);
User user = event.getOption("user", OptionMapping::getAsUser);
FormData form = formOpt.get();

int count = formsRepo.deleteSubmissions(form, user);
Expand All @@ -54,24 +53,8 @@ public void execute(SlashCommandInteractionEvent event) {

@Override
public void handleAutoComplete(CommandAutoCompleteInteractionEvent event, AutoCompleteQuery target) {
switch (target.getName()) {
case "user-id" -> {
Long formId = event.getOption("form-id", OptionMapping::getAsLong);
if (formId != null) {
Optional<FormData> form = formsRepo.getForm(formId);
if (form.isPresent()) {
event.replyChoices(formsRepo.getAllSubmissions(form.get()).keySet().stream()
.map(user -> new Choice(user.getUsername(), Long.toString(user.getId()))).toList())
.queue();
return;
}
}
event.replyChoices().queue();
}
case "form-id" -> event.replyChoices(
formsRepo.getAllForms().stream().map(form -> new Choice(form.toString(), form.getId())).toList())
.queue();
default -> {}
}
event.replyChoices(
formsRepo.getAllForms().stream().map(form -> new Choice(form.toString(), form.getId())).toList())
.queue();
}
}
2 changes: 1 addition & 1 deletion ...ordjug/javabot/systems/staff_commands/forms/commands/SubmissionsExportFormSubcommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ public void execute(SlashCommandInteractionEvent event) {
}

FormData form = formOpt.get();
Map<FormUser, Integer> submissions = formsRepo.getAllSubmissions(form);
Map<FormUser, Integer> submissions = formsRepo.getSubmissionsCountPerUser(form);
JsonObject root = new JsonObject();
JsonObject details = new JsonObject();
JsonArray users = new JsonArray();
Expand Down
Loading
Loading