Merge pull request #335 from Java-Discord/dynxsty/user_preferences

User Preferences & QOTW Reminder

Author: jasonlessenich

src/main/java/net/javadiscord/javabot/Bot.java

@@ -109,7 +109,7 @@ public static void main(String[] args) throws Exception {
 		AllowedMentions.setDefaultMentions(EnumSet.of(Message.MentionType.ROLE, Message.MentionType.CHANNEL, Message.MentionType.USER, Message.MentionType.EMOJI));
 		dih4jda = DIH4JDABuilder.setJDA(jda)
 				.setCommandsPackage("net.javadiscord.javabot")
-				.setDefaultCommandType(RegistrationType.GUILD)
+				.setDefaultCommandType(RegistrationType.GLOBAL)
 				.build();
 		customTagManager = new CustomTagManager(jda, dataSource);
 		messageCache = new MessageCache();

src/main/java/net/javadiscord/javabot/systems/qotw/QOTWUserReminderJob.java

@@ -0,0 +1,44 @@
+package net.javadiscord.javabot.systems.qotw;
+
+import net.dv8tion.jda.api.JDA;
+import net.dv8tion.jda.api.entities.Guild;
+import net.dv8tion.jda.api.entities.TextChannel;
+import net.javadiscord.javabot.Bot;
+import net.javadiscord.javabot.data.config.guild.QOTWConfig;
+import net.javadiscord.javabot.systems.qotw.submissions.SubmissionManager;
+import net.javadiscord.javabot.systems.qotw.submissions.model.QOTWSubmission;
+import net.javadiscord.javabot.systems.user_preferences.UserPreferenceManager;
+import net.javadiscord.javabot.systems.user_preferences.model.Preference;
+import net.javadiscord.javabot.systems.user_preferences.model.UserPreference;
+import net.javadiscord.javabot.tasks.jobs.DiscordApiJob;
+import org.jetbrains.annotations.NotNull;
+import org.quartz.JobExecutionContext;
+import org.quartz.JobExecutionException;
+
+import java.util.List;
+
+/**
+ * Checks that there's a question in the QOTW queue ready for posting soon.
+ */
+public class QOTWUserReminderJob extends DiscordApiJob {
+	@Override
+	protected void execute(JobExecutionContext context, @NotNull JDA jda) throws JobExecutionException {
+		for (Guild guild : jda.getGuilds()) {
+			QOTWConfig config = Bot.getConfig().get(guild).getQotwConfig();
+			List<QOTWSubmission> submissions = new SubmissionManager(config).getActiveSubmissionThreads();
+			for (QOTWSubmission submission : submissions) {
+				UserPreferenceManager manager = new UserPreferenceManager(Bot.getDataSource());
+				UserPreference preference = manager.getOrCreate(submission.getAuthorId(), Preference.QOTW_REMINDER);
+				if (preference.isEnabled()) {
+					TextChannel channel = config.getSubmissionChannel();
+					channel.getThreadChannels().stream().filter(t -> t.getIdLong() == submission.getThreadId()).forEach(t -> {
+						if (t.getMessageCount() <= 1) {
+							t.sendMessageFormat("**Question of the Week Reminder**\nHey <@%s>! You still have some time left to submit your answer!", submission.getAuthorId())
+									.queue();
+						}
+					});
+				}
+			}
+		}
+	}
+}

src/main/java/net/javadiscord/javabot/systems/qotw/submissions/SubmissionManager.java

@@ -25,6 +25,7 @@
 import java.sql.Connection;
 import java.sql.SQLException;
 import java.time.Instant;
+import java.util.List;
 import java.util.Optional;
 
 /**
@@ -129,6 +130,21 @@ public boolean hasActiveSubmissionThreads(long authorId) {
 		}
 	}
 
+	/**
+	 * Gets all active submission threads.
+	 *
+	 * @return An immutable {@link List} of {@link QOTWSubmission}s.
+	 */
+	public List<QOTWSubmission> getActiveSubmissionThreads() {
+		try (Connection con = Bot.getDataSource().getConnection()) {
+			QOTWSubmissionRepository repo = new QOTWSubmissionRepository(con);
+			return repo.getSubmissionByQuestionNumber(repo.getCurrentQuestionNumber());
+		} catch (SQLException e) {
+			ExceptionLogger.capture(e, getClass().getSimpleName());
+			return List.of();
+		}
+	}
+
 	private @NotNull MessageEmbed buildSubmissionThreadEmbed(@NotNull User createdBy, @NotNull QOTWQuestion question, @NotNull QOTWConfig config) {
 		return new EmbedBuilder()
 				.setColor(Responses.Type.DEFAULT.getColor())

src/main/java/net/javadiscord/javabot/systems/staff_commands/tags/commands/TagsCommand.java

@@ -12,7 +12,9 @@ public class TagsCommand extends SlashCommand {
 	 * adds the corresponding {@link net.dv8tion.jda.api.interactions.commands.Command.Subcommand}s.
 	 */
 	public TagsCommand() {
-		setSlashCommandData(Commands.slash("tag", "Commands for interacting with Custom Tags."));
+		setSlashCommandData(Commands.slash("tag", "Commands for interacting with Custom Tags.")
+				.setGuildOnly(true)
+		);
 		addSubcommands(new TagViewSubcommand(), new TagListSubcommand());
 	}
 }

src/main/java/net/javadiscord/javabot/systems/user_preferences/UserPreferenceManager.java

@@ -0,0 +1,76 @@
+package net.javadiscord.javabot.systems.user_preferences;
+
+import lombok.RequiredArgsConstructor;
+import net.javadiscord.javabot.systems.user_preferences.dao.UserPreferenceRepository;
+import net.javadiscord.javabot.systems.user_preferences.model.Preference;
+import net.javadiscord.javabot.systems.user_preferences.model.UserPreference;
+import net.javadiscord.javabot.util.ExceptionLogger;
+
+import javax.sql.DataSource;
+import java.sql.Connection;
+import java.sql.SQLException;
+import java.util.Optional;
+
+/**
+ * Handles & manages user preferences.
+ */
+@RequiredArgsConstructor
+public class UserPreferenceManager {
+	private final DataSource dataSource;
+
+	/**
+	 * Simply sets the state of the specified {@link Preference} for the specified user.
+	 * If no entry for that user is found, this will simply create a new one.
+	 *
+	 * @param userId     The users' id.
+	 * @param preference The {@link Preference} to change the state for.
+	 * @param enabled    The preferences' state.
+	 * @return Whether the operation was successful.
+	 */
+	public boolean setOrCreate(long userId, Preference preference, boolean enabled) {
+		try (Connection con = dataSource.getConnection()) {
+			UserPreferenceRepository repo = new UserPreferenceRepository(con);
+			Optional<UserPreference> preferenceOptional = repo.getById(userId, preference);
+			if (preferenceOptional.isPresent()) {
+				return repo.updateState(userId, preference, enabled);
+			} else {
+				UserPreference userPreference = new UserPreference();
+				userPreference.setUserId(userId);
+				userPreference.setPreference(preference);
+				userPreference.setEnabled(enabled);
+				repo.insert(userPreference, false);
+				return true;
+			}
+		} catch (SQLException e) {
+			ExceptionLogger.capture(e, getClass().getSimpleName());
+			return false;
+		}
+	}
+
+	/**
+	 * Gets a single {@link UserPreference} (or creates a new one if it doesn't exist yet).
+	 *
+	 * @param userId     The users' id.
+	 * @param preference The {@link Preference} to get.
+	 * @return The {@link UserPreference}.
+	 */
+	public UserPreference getOrCreate(long userId, Preference preference) {
+		try (Connection con = dataSource.getConnection()) {
+			UserPreferenceRepository repo = new UserPreferenceRepository(con);
+			Optional<UserPreference> preferenceOptional = repo.getById(userId, preference);
+			if (preferenceOptional.isPresent()) {
+				return preferenceOptional.get();
+			} else {
+				UserPreference userPreference = new UserPreference();
+				userPreference.setUserId(userId);
+				userPreference.setPreference(preference);
+				userPreference.setEnabled(preference.getDefaultState());
+				repo.insert(userPreference, false);
+				return userPreference;
+			}
+		} catch (SQLException e) {
+			ExceptionLogger.capture(e, getClass().getSimpleName());
+			return null;
+		}
+	}
+}

src/main/java/net/javadiscord/javabot/systems/user_preferences/commands/PreferencesCommand.java

@@ -0,0 +1,19 @@
+package net.javadiscord.javabot.systems.user_preferences.commands;
+
+import com.dynxsty.dih4jda.interactions.commands.SlashCommand;
+import net.dv8tion.jda.api.interactions.commands.build.Commands;
+
+/**
+ * <h3>This class represents the /preferences command.</h3>
+ */
+public class PreferencesCommand extends SlashCommand {
+	/**
+	 * The constructor of this class, which sets the corresponding {@link net.dv8tion.jda.api.interactions.commands.build.SlashCommandData}.
+	 */
+	public PreferencesCommand() {
+		setSlashCommandData(Commands.slash("preferences", "Contains commands for managing user preferences.")
+				.setGuildOnly(true)
+		);
+		addSubcommands(new PreferencesListSubcommand(), new PreferencesSetSubcommand());
+	}
+}

src/main/java/net/javadiscord/javabot/systems/user_preferences/commands/PreferencesListSubcommand.java

@@ -0,0 +1,34 @@
+package net.javadiscord.javabot.systems.user_preferences.commands;
+
+import com.dynxsty.dih4jda.interactions.commands.SlashCommand;
+import net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent;
+import net.dv8tion.jda.api.interactions.commands.build.SubcommandData;
+import net.javadiscord.javabot.Bot;
+import net.javadiscord.javabot.systems.user_preferences.UserPreferenceManager;
+import net.javadiscord.javabot.systems.user_preferences.model.Preference;
+import net.javadiscord.javabot.util.Responses;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.Arrays;
+import java.util.stream.Collectors;
+
+/**
+ * <h3>This class represents the /preferences list command.</h3>
+ */
+public class PreferencesListSubcommand extends SlashCommand.Subcommand {
+	/**
+	 * The constructor of this class, which sets the corresponding {@link net.dv8tion.jda.api.interactions.commands.build.SlashCommandData}.
+	 */
+	public PreferencesListSubcommand() {
+		setSubcommandData(new SubcommandData("list", "Shows all your preferences."));
+	}
+
+	@Override
+	public void execute(@NotNull SlashCommandInteractionEvent event) {
+		UserPreferenceManager manager = new UserPreferenceManager(Bot.getDataSource());
+		String preferences = Arrays.stream(Preference.values())
+				.map(p -> String.format("`%s` %s", manager.getOrCreate(event.getUser().getIdLong(), p).isEnabled() ? "\uD83D\uDFE2" : "\uD83D\uDD34", p))
+				.collect(Collectors.joining("\n"));
+		Responses.info(event, String.format("%s's Preferences", event.getUser().getName()), preferences).queue();
+	}
+}

src/main/java/net/javadiscord/javabot/systems/user_preferences/commands/PreferencesSetSubcommand.java

@@ -0,0 +1,58 @@
+package net.javadiscord.javabot.systems.user_preferences.commands;
+
+import com.dynxsty.dih4jda.interactions.commands.SlashCommand;
+import net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent;
+import net.dv8tion.jda.api.interactions.commands.Command;
+import net.dv8tion.jda.api.interactions.commands.OptionMapping;
+import net.dv8tion.jda.api.interactions.commands.OptionType;
+import net.dv8tion.jda.api.interactions.commands.build.OptionData;
+import net.dv8tion.jda.api.interactions.commands.build.SubcommandData;
+import net.javadiscord.javabot.Bot;
+import net.javadiscord.javabot.systems.user_preferences.UserPreferenceManager;
+import net.javadiscord.javabot.systems.user_preferences.model.Preference;
+import net.javadiscord.javabot.util.Responses;
+import org.jetbrains.annotations.Contract;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.Arrays;
+
+/**
+ * <h3>This class represents the /preferences set command.</h3>
+ */
+public class PreferencesSetSubcommand extends SlashCommand.Subcommand {
+	/**
+	 * The constructor of this class, which sets the corresponding {@link net.dv8tion.jda.api.interactions.commands.build.SlashCommandData}.
+	 */
+	public PreferencesSetSubcommand() {
+		setSubcommandData(new SubcommandData("set", "Allows you to set your preferences!")
+				.addOptions(
+						new OptionData(OptionType.INTEGER, "preference", "The preference to set.", true)
+								.addChoices(Arrays.stream(Preference.values()).map(this::toChoice).toList()),
+						new OptionData(OptionType.BOOLEAN, "state", "The state of the specified preference.", true)
+				)
+		);
+	}
+
+	@Override
+	public void execute(@NotNull SlashCommandInteractionEvent event) {
+		OptionMapping preferenceMapping = event.getOption("preference");
+		OptionMapping stateMapping = event.getOption("state");
+		if (preferenceMapping == null || stateMapping == null) {
+			Responses.replyMissingArguments(event).queue();
+			return;
+		}
+		Preference preference = Preference.values()[preferenceMapping.getAsInt()];
+		boolean state = stateMapping.getAsBoolean();
+		UserPreferenceManager manager = new UserPreferenceManager(Bot.getDataSource());
+		if (manager.setOrCreate(event.getUser().getIdLong(), preference, state)) {
+			Responses.info(event, "Preference Updated", "Successfully %s `%s`!", state ? "enabled" : "disabled", preference).queue();
+		} else {
+			Responses.error(event, "Could not %s `%s`.", state ? "enable" : "disable", preference).queue();
+		}
+	}
+
+	@Contract("_ -> new")
+	private Command.@NotNull Choice toChoice(@NotNull Preference preference) {
+		return new Command.Choice(preference.toString(), String.valueOf(preference.ordinal()));
+	}
+}

src/main/java/net/javadiscord/javabot/systems/user_preferences/dao/UserPreferenceRepository.java

@@ -0,0 +1,40 @@
+package net.javadiscord.javabot.systems.user_preferences.dao;
+
+import net.javadiscord.javabot.data.h2db.DatabaseRepository;
+import net.javadiscord.javabot.data.h2db.TableProperty;
+import net.javadiscord.javabot.systems.user_preferences.model.Preference;
+import net.javadiscord.javabot.systems.user_preferences.model.UserPreference;
+import org.h2.api.H2Type;
+import org.jetbrains.annotations.NotNull;
+
+import java.sql.Connection;
+import java.sql.SQLException;
+import java.util.List;
+import java.util.Optional;
+
+/**
+ * Dao class that represents the USER_PREFERENCES SQL Table.
+ */
+public class UserPreferenceRepository extends DatabaseRepository<UserPreference> {
+	/**
+	 * The constructor of this {@link DatabaseRepository} class which defines all important information
+	 * about the USER_PREFERENCES database table.
+	 *
+	 * @param con The {@link Connection} to use.
+	 */
+	public UserPreferenceRepository(Connection con) {
+		super(con, UserPreference.class, "USER_PREFERENCES", List.of(
+				TableProperty.of("user_id", H2Type.BIGINT, (x, y) -> x.setUserId((Long) y), UserPreference::getUserId),
+				TableProperty.of("ordinal", H2Type.INTEGER, (x, y) -> x.setPreference(Preference.values()[(Integer) y]), p -> p.getPreference().ordinal()),
+				TableProperty.of("enabled", H2Type.BOOLEAN, (x, y) -> x.setEnabled((Boolean) y), UserPreference::isEnabled)
+		));
+	}
+
+	public Optional<UserPreference> getById(long userId, @NotNull Preference preference) throws SQLException {
+		return querySingle("WHERE user_id = ? AND ordinal = ?", userId, preference.ordinal());
+	}
+
+	public boolean updateState(long userId, @NotNull Preference preference, boolean enabled) throws SQLException {
+		return update("UPDATE user_preferences SET enabled = ? WHERE user_id = ? AND ordinal = ?", enabled, userId, preference.ordinal()) > 0;
+	}
+}

src/main/java/net/javadiscord/javabot/systems/user_preferences/model/Preference.java

@@ -0,0 +1,28 @@
+package net.javadiscord.javabot.systems.user_preferences.model;
+
+/**
+ * Contains all preferences users can set.
+ */
+public enum Preference {
+	/**
+	 * Enables/Disables QOTW reminders.
+	 */
+	QOTW_REMINDER("Question of the Week Reminder", false);
+
+	private final String name;
+	private final boolean defaultState;
+
+	Preference(String name, boolean defaultState) {
+		this.name = name;
+		this.defaultState = defaultState;
+	}
+
+	@Override
+	public String toString() {
+		return name;
+	}
+
+	public boolean getDefaultState() {
+		return defaultState;
+	}
+}