Started work on implementing user preferences

Author: jasonlessenich

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

@@ -0,0 +1,49 @@
+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 set(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.setOrdinal(preference.ordinal());
+				userPreference.setEnabled(enabled);
+				repo.insert(userPreference, false);
+				return true;
+			}
+		} catch (SQLException e) {
+			ExceptionLogger.capture(e, getClass().getSimpleName());
+			return false;
+		}
+	}
+}

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

@@ -0,0 +1,66 @@
+package net.javadiscord.javabot.systems.user_preferences.commands;
+
+import com.dynxsty.dih4jda.interactions.commands.AutoCompletable;
+import com.dynxsty.dih4jda.interactions.commands.SlashCommand;
+import com.dynxsty.dih4jda.util.AutoCompleteUtils;
+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;
+import net.dv8tion.jda.api.interactions.commands.OptionMapping;
+import net.dv8tion.jda.api.interactions.commands.OptionType;
+import net.dv8tion.jda.api.interactions.commands.build.Commands;
+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.ArrayList;
+import java.util.List;
+
+/**
+ * <h3>This class represents the /preferences command.</h3>
+ */
+public class UserPreferenceCommand extends SlashCommand implements AutoCompletable {
+	/**
+	 * The constructor of this class, which sets the corresponding {@link net.dv8tion.jda.api.interactions.commands.build.SlashCommandData}.
+	 */
+	public UserPreferenceCommand() {
+		setSlashCommandData(Commands.slash("preferences", "Allows you to set some preferences!")
+				.addOption(OptionType.INTEGER, "preference", "The preference to set.", true, true)
+				.addOption(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.set(event.getUser().getIdLong(), preference, state)) {
+			Responses.info(event, "Preference Updated", "Successfully set `%s` to `%s`!", preference, state).queue();
+		} else {
+			Responses.error(event, "Could not update `%s` to `%s`.", preference, state).queue();
+		}
+	}
+
+	private @NotNull List<Command.Choice> getPreferenceChoices() {
+		List<Command.Choice> choices = new ArrayList<>(Preference.values().length);
+		for (Preference p : Preference.values()) {
+			choices.add(new Command.Choice(p.toString(), p.ordinal()));
+		}
+		return choices;
+	}
+
+	@Override
+	public void handleAutoComplete(@NotNull CommandAutoCompleteInteractionEvent event, @NotNull AutoCompleteQuery target) {
+		event.replyChoices(AutoCompleteUtils.handleChoices(event, e -> getPreferenceChoices())).queue();
+	}
+}

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.setOrdinal((Integer) y),    UserPreference::getOrdinal),
+				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,22 @@
+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");
+
+	private final String name;
+
+	Preference(String name) {
+		this.name = name;
+	}
+
+	@Override
+	public String toString() {
+		return name;
+	}
+}

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

@@ -0,0 +1,17 @@
+package net.javadiscord.javabot.systems.user_preferences.model;
+
+import lombok.Data;
+
+/**
+ * Data class which represents a single user preference.
+ */
+@Data
+public class UserPreference {
+	private long userId;
+	private int ordinal;
+	private boolean enabled;
+
+	public Preference getPreference() {
+		return Preference.values()[ordinal];
+	}
+}

src/main/resources/database/schema.sql

@@ -104,3 +104,12 @@ CREATE TABLE message_cache
 	author_id       BIGINT        NOT NULL,
 	message_content VARCHAR(4000) NOT NULL
 );
+
+// User Preferences
+CREATE TABLE user_preferences
+(
+	user_id BIGINT  NOT NULL,
+	ordinal INTEGER NOT NULL,
+	enabled BOOLEAN NOT NULL DEFAULT TRUE,
+	PRIMARY KEY (user_id, ordinal)
+)