Forms system

A command to attach form buttons to bot's messages
Form data deserialization
Store forms in database
Use an array of form fields instead of a form data object
Move `FormsRepository` and `FormField` to different packages
Reading forms from database
Open modals on form button interaction
Log submissions in a configured channel
Allow setting a custom submission message
Use an *Empty* value if user ommits a field
Ignore case when parsing form field text input styles
Store forms' origin messages, their channels, and expiration date
Form delete command autocompletion
Form delete command
Forms closing and reopening commands
Form details command
Form modification command
Check if the form is not closed or expired on submission
Reword expiration command parameter description
Additional checks in all form commands
Don't accept raw JSON data and don't immediately attach forms
Added `add-field` form command
Form field remove command
Form show command
Put a limit of 5 components for forms
Allow field inserting
Forms attach and detach commands
Prevent removing the last field from an attached form
Javadocs
Remove redundant checks from form commands
Move some common methods to the form interaction manager
Added `hasExpired` method to `FormData`
Add `onetime` form parameter
Logging form submissions to the database
Add a repository method to query forms for a specific `closed` state
Include total submissions count in the form details message
Additional null checks in the forms repository
Prevent further submissions to one-time forms
A command to export all form submissions
Delete form submissions on form deletion
Command to delete user's submissions
Fix checkstyle violations

Author: Defective4

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/FormInteractionManager.java

@@ -0,0 +1,275 @@
+package net.discordjug.javabot.systems.staff_commands.forms;
+
+import java.text.DateFormat;
+import java.text.ParseException;
+import java.text.SimpleDateFormat;
+import java.time.Instant;
+import java.util.List;
+import java.util.Locale;
+import java.util.Objects;
+import java.util.Optional;
+import java.util.TimeZone;
+import java.util.function.Function;
+
+import lombok.RequiredArgsConstructor;
+import net.discordjug.javabot.annotations.AutoDetectableComponentHandler;
+import net.discordjug.javabot.systems.staff_commands.forms.dao.FormsRepository;
+import net.discordjug.javabot.systems.staff_commands.forms.model.FormData;
+import net.discordjug.javabot.systems.staff_commands.forms.model.FormField;
+import net.dv8tion.jda.api.EmbedBuilder;
+import net.dv8tion.jda.api.entities.Guild;
+import net.dv8tion.jda.api.entities.Member;
+import net.dv8tion.jda.api.entities.Message;
+import net.dv8tion.jda.api.entities.MessageEmbed;
+import net.dv8tion.jda.api.entities.channel.concrete.TextChannel;
+import net.dv8tion.jda.api.events.interaction.ModalInteractionEvent;
+import net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent;
+import net.dv8tion.jda.api.events.interaction.component.ButtonInteractionEvent;
+import net.dv8tion.jda.api.interactions.commands.OptionMapping;
+import net.dv8tion.jda.api.interactions.components.ActionRow;
+import net.dv8tion.jda.api.interactions.components.ItemComponent;
+import net.dv8tion.jda.api.interactions.components.buttons.Button;
+import net.dv8tion.jda.api.interactions.modals.Modal;
+import net.dv8tion.jda.api.interactions.modals.ModalMapping;
+import xyz.dynxsty.dih4jda.interactions.components.ButtonHandler;
+import xyz.dynxsty.dih4jda.interactions.components.ModalHandler;
+import xyz.dynxsty.dih4jda.util.ComponentIdBuilder;
+
+/**
+ * Handle forms interactions, including buttons and submissions modals.
+ */
+@AutoDetectableComponentHandler(FormInteractionManager.FORM_COMPONENT_ID)
+@RequiredArgsConstructor
+public class FormInteractionManager implements ButtonHandler, ModalHandler {
+
+	/**
+	 * Date and time format used in forms.
+	 */
+	public static final DateFormat DATE_FORMAT;
+
+	/**
+	 * String representation of the date and time format used in forms.
+	 */
+	public static final String DATE_FORMAT_STRING;
+
+	/**
+	 * Component ID used for form buttons and modals.
+	 */
+	public static final String FORM_COMPONENT_ID = "modal-form";
+	private static final String FORM_NOT_FOUND_MSG = "This form was not found in the database. Please report this to the server staff.";
+
+	private final FormsRepository formsRepo;
+
+	static {
+		DATE_FORMAT_STRING = "dd/MM/yyyy HH:mm";
+		DATE_FORMAT = new SimpleDateFormat(FormInteractionManager.DATE_FORMAT_STRING, Locale.ENGLISH);
+		DATE_FORMAT.setTimeZone(TimeZone.getTimeZone("UTC"));
+	}
+
+	/**
+	 * Closes the form, preventing further submissions and disabling associated
+	 * buttons from a message this form is attached to, if any.
+	 *
+	 * @param guild guild this form is located in.
+	 * @param form  form to close.
+	 */
+	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 -> {
+				mapFormMessageButtons(msg, btn -> {
+					String cptId = btn.getId();
+					String[] split = ComponentIdBuilder.split(cptId);
+					if (split[0].equals(FormInteractionManager.FORM_COMPONENT_ID)
+							&& split[1].equals(Long.toString(form.getId()))) {
+						return btn.asDisabled();
+					}
+					return btn;
+				});
+			}, t -> {});
+		}
+	}
+
+	@Override
+	public void handleButton(ButtonInteractionEvent event, Button button) {
+		long formId = Long.parseLong(ComponentIdBuilder.split(button.getId())[1]);
+		Optional<FormData> formOpt = formsRepo.getForm(formId);
+		if (!formOpt.isPresent()) {
+			event.reply(FORM_NOT_FOUND_MSG).setEphemeral(true).queue();
+			return;
+		}
+		FormData form = formOpt.get();
+		if (!checkNotClosed(form)) {
+			event.reply("This form is not accepting new submissions.").setEphemeral(true).queue();
+			if (!form.isClosed()) {
+				closeForm(event.getGuild(), form);
+			}
+			return;
+		}
+
+		if (form.isOnetime() && formsRepo.hasSubmitted(event.getUser(), form)) {
+			event.reply("You have already submitted this form").setEphemeral(true).queue();
+			return;
+		}
+
+		Modal modal = createFormModal(form);
+
+		event.replyModal(modal).queue();
+	}
+
+	@Override
+	public void handleModal(ModalInteractionEvent event, List<ModalMapping> values) {
+		event.deferReply().setEphemeral(true).queue();
+		long formId = Long.parseLong(ComponentIdBuilder.split(event.getModalId())[1]);
+		Optional<FormData> formOpt = formsRepo.getForm(formId);
+		if (!formOpt.isPresent()) {
+			event.reply(FORM_NOT_FOUND_MSG).setEphemeral(true).queue();
+			return;
+		}
+
+		FormData form = formOpt.get();
+
+		if (!checkNotClosed(form)) {
+			event.getHook().sendMessage("This form is not accepting new submissions.").queue();
+			return;
+		}
+
+		if (form.isOnetime() && formsRepo.hasSubmitted(event.getUser(), form)) {
+			event.getHook().sendMessage("You have already submitted this form").queue();
+			return;
+		}
+
+		TextChannel channel = event.getGuild().getTextChannelById(form.getSubmitChannel());
+		if (channel == null) {
+			event.getHook()
+					.sendMessage("We couldn't receive your submission due to an error. Please contact server staff.")
+					.queue();
+			return;
+		}
+
+		channel.sendMessageEmbeds(createSubmissionEmbed(form, values, event.getMember())).queue();
+		formsRepo.logSubmission(event.getUser(), form);
+
+		event.getHook()
+				.sendMessage(
+						form.getSubmitMessage() == null ? "Your submission was received!" : form.getSubmitMessage())
+				.queue();
+	}
+
+	/**
+	 * Modifies buttons in a message using given function for mapping.
+	 *
+	 * @param msg    message to modify buttons in.
+	 * @param mapper mapping function.
+	 */
+	public void mapFormMessageButtons(Message msg, Function<Button, Button> mapper) {
+		List<ActionRow> components = msg.getActionRows().stream().map(row -> {
+			ItemComponent[] cpts = row.getComponents().stream().map(cpt -> {
+				if (cpt instanceof Button btn) {
+					return mapper.apply(btn);
+				}
+				return cpt;
+			}).toList().toArray(new ItemComponent[0]);
+			if (cpts.length == 0) {
+				return null;
+			}
+			return ActionRow.of(cpts);
+		}).filter(Objects::nonNull).toList();
+		msg.editMessageComponents(components).queue();
+	}
+
+	/**
+	 * Re-opens the form, re-enabling associated buttons in message it's attached
+	 * to, if any.
+	 *
+	 * @param guild guild this form is contained in.
+	 * @param form  form to re-open.
+	 */
+	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 -> {
+				mapFormMessageButtons(msg, btn -> {
+					String cptId = btn.getId();
+					String[] split = ComponentIdBuilder.split(cptId);
+					if (split[0].equals(FormInteractionManager.FORM_COMPONENT_ID)
+							&& split[1].equals(Long.toString(form.getId()))) {
+						return btn.asEnabled();
+					}
+					return btn;
+				});
+			}, t -> {});
+		}
+	}
+
+	/**
+	 * Creates a submission modal for the given form.
+	 *
+	 * @param form form to open submission modal for.
+	 * @return submission modal to be presented to the user.
+	 */
+	public static Modal createFormModal(FormData form) {
+		Modal modal = Modal.create(ComponentIdBuilder.build(FORM_COMPONENT_ID, form.getId()), form.getTitle())
+				.addComponents(form.createComponents()).build();
+		return modal;
+	}
+
+	/**
+	 * Gets expiration time from the slash comamnd event.
+	 *
+	 * @param event slash event to get expiration from.
+	 * @return an optional containing expiration time,
+	 *         {@link FormData#EXPIRATION_PERMANENT} if none given, or an empty
+	 *         optional if it's invalid.
+	 */
+	public static Optional<Long> parseExpiration(SlashCommandInteractionEvent event) {
+		String expirationStr = event.getOption("expiration", null, OptionMapping::getAsString);
+		Optional<Long> expiration;
+		if (expirationStr == null) {
+			expiration = Optional.of(FormData.EXPIRATION_PERMANENT);
+		} else {
+			try {
+				expiration = Optional.of(FormInteractionManager.DATE_FORMAT.parse(expirationStr).getTime());
+			} catch (ParseException e) {
+				event.getHook().sendMessage("Invalid date. You should follow the format `"
+						+ FormInteractionManager.DATE_FORMAT_STRING + "`.").setEphemeral(true).queue();
+				expiration = Optional.empty();
+			}
+		}
+
+		if (expiration.isPresent() && expiration.get() != FormData.EXPIRATION_PERMANENT
+				&& expiration.get() < System.currentTimeMillis()) {
+			event.getHook().sendMessage("The expiration date shouldn't be in the past").setEphemeral(true).queue();
+			return Optional.empty();
+		}
+		return expiration;
+	}
+
+	private static boolean checkNotClosed(FormData data) {
+		if (data.isClosed() || data.hasExpired()) {
+			return false;
+		}
+
+		return true;
+	}
+
+	private static MessageEmbed createSubmissionEmbed(FormData form, List<ModalMapping> values, Member author) {
+		EmbedBuilder builder = new EmbedBuilder().setTitle("New form submission received")
+				.setAuthor(author.getEffectiveName(), null, author.getEffectiveAvatarUrl()).setTimestamp(Instant.now());
+		builder.addField("Sender", author.getAsMention(), true).addField("Title", form.getTitle(), true);
+
+		int len = Math.min(values.size(), form.getFields().size());
+		for (int i = 0; i < len; i++) {
+			ModalMapping mapping = values.get(i);
+			FormField field = form.getFields().get(i);
+			String value = mapping.getAsString();
+			builder.addField(field.getLabel(), value == null ? "*Empty*" : "```\n" + value + "\n```", false);
+		}
+
+		return builder.build();
+	}
+}

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/commands/AddFieldFormSubcommand.java

@@ -0,0 +1,103 @@
+package net.discordjug.javabot.systems.staff_commands.forms.commands;
+
+import java.util.Arrays;
+import java.util.Optional;
+
+import net.discordjug.javabot.systems.staff_commands.forms.dao.FormsRepository;
+import net.discordjug.javabot.systems.staff_commands.forms.model.FormData;
+import net.discordjug.javabot.systems.staff_commands.forms.model.FormField;
+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;
+import net.dv8tion.jda.api.interactions.commands.Command.Choice;
+import net.dv8tion.jda.api.interactions.commands.OptionMapping;
+import net.dv8tion.jda.api.interactions.commands.OptionType;
+import net.dv8tion.jda.api.interactions.commands.build.SubcommandData;
+import net.dv8tion.jda.api.interactions.components.text.TextInputStyle;
+import xyz.dynxsty.dih4jda.interactions.AutoCompletable;
+import xyz.dynxsty.dih4jda.interactions.commands.application.SlashCommand.Subcommand;
+
+/**
+ * The `/form add-field` command.
+ */
+public class AddFieldFormSubcommand extends Subcommand implements AutoCompletable {
+
+	private final FormsRepository formsRepo;
+
+	/**
+	 * The main constructor of this subcommand.
+	 *
+	 * @param formsRepo the forms repository
+	 */
+	public AddFieldFormSubcommand(FormsRepository formsRepo) {
+		this.formsRepo = formsRepo;
+		setCommandData(new SubcommandData("add-field", "Adds a field to an existing form")
+				.addOption(OptionType.INTEGER, "form-id", "Form ID to add the field to", true, true)
+				.addOption(OptionType.STRING, "label", "Field label", true)
+				.addOption(OptionType.INTEGER, "min", "Minimum number of characters")
+				.addOption(OptionType.INTEGER, "max", "Maximum number of characters")
+				.addOption(OptionType.STRING, "placeholder", "Field placeholder")
+				.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)
+				.addOption(OptionType.STRING, "value", "Initial field value")
+				.addOption(OptionType.INTEGER, "index", "Index to insert the field at"));
+	}
+
+	@Override
+	public void execute(SlashCommandInteractionEvent event) {
+
+		event.deferReply(true).queue();
+		Optional<FormData> formOpt = formsRepo.getForm(event.getOption("form-id", OptionMapping::getAsLong));
+		if (formOpt.isEmpty()) {
+			event.getHook().sendMessage("A form with this ID was not found.").queue();
+			return;
+		}
+		FormData form = formOpt.get();
+
+		if (form.getFields().size() >= 5) {
+			event.getHook().sendMessage("Can't add more than 5 components to a form").queue();
+			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);
+		event.getHook().sendMessage("Added a new field to the form.").queue();
+	}
+
+	@Override
+	public void handleAutoComplete(CommandAutoCompleteInteractionEvent event, AutoCompleteQuery target) {
+		switch (target.getName()) {
+			case "form-id" -> event.replyChoices(
+					formsRepo.getAllForms().stream().map(form -> new Choice(form.toString(), form.getId())).toList())
+					.queue();
+			case "style" ->
+				event.replyChoices(Arrays.stream(TextInputStyle.values()).filter(t -> t != TextInputStyle.UNKNOWN)
+						.map(style -> new Choice(style.name(), style.name())).toList()).queue();
+			default -> {}
+		}
+	}
+
+	private static FormField createFormFieldFromEvent(SlashCommandInteractionEvent e) {
+		String label = e.getOption("label", OptionMapping::getAsString);
+		int min = e.getOption("min", 0, OptionMapping::getAsInt);
+		int max = e.getOption("max", 64, OptionMapping::getAsInt);
+		String placeholder = e.getOption("placeholder", OptionMapping::getAsString);
+		boolean required = e.getOption("required", false, OptionMapping::getAsBoolean);
+		TextInputStyle style = e.getOption("style", TextInputStyle.SHORT, t -> {
+			try {
+				return TextInputStyle.valueOf(t.getAsString().toUpperCase());
+			} catch (IllegalArgumentException e2) {
+				return TextInputStyle.SHORT;
+			}
+		});
+		String value = e.getOption("value", OptionMapping::getAsString);
+
+		return new FormField(label, max, min, placeholder, required, style.name(), value);
+	}
+}