graphical help XP leaderboard

Author: danthe1st

src/main/java/net/javadiscord/javabot/systems/help/HelpExperienceService.java

@@ -11,7 +11,9 @@
 import net.javadiscord.javabot.systems.help.dao.HelpTransactionRepository;
 import net.javadiscord.javabot.systems.help.model.HelpAccount;
 import net.javadiscord.javabot.systems.help.model.HelpTransaction;
+import net.javadiscord.javabot.systems.user_commands.leaderboard.ExperienceLeaderboardSubcommand;
 import net.javadiscord.javabot.util.ExceptionLogger;
+import net.javadiscord.javabot.util.ImageCache;
 import net.javadiscord.javabot.util.Pair;
 import org.jetbrains.annotations.NotNull;
 import org.springframework.dao.DataAccessException;
@@ -97,6 +99,7 @@ public void performTransaction(long recipient, double value, Guild guild, long c
 		helpTransactionRepository.save(transaction);
 		checkExperienceRoles(guild, account);
 		log.info("Added {} help experience to {}'s help account", value, recipient);
+		ImageCache.removeCachedImagesByKeyword(ExperienceLeaderboardSubcommand.CACHE_PREFIX);
 	}
 
 	private void checkExperienceRoles(@NotNull Guild guild, @NotNull HelpAccount account) {
@@ -114,10 +117,10 @@ private void checkExperienceRoles(@NotNull Guild guild, @NotNull HelpAccount acc
 					}
 				}), e -> {});
 	}
-	
+
 	/**
 	 * add XP to all helpers depending on the messages they sent.
-	 * 
+	 *
 	 * @param post The {@link ThreadChannel} post
 	 * @param allowIfXPAlreadyGiven {@code true} if XP should be awarded if XP have already been awarded
 	 */

src/main/java/net/javadiscord/javabot/systems/user_commands/leaderboard/ExperienceLeaderboardSubcommand.java

@@ -6,10 +6,9 @@
 import xyz.dynxsty.dih4jda.interactions.components.ButtonHandler;
 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.MessageEmbed;
-import net.dv8tion.jda.api.entities.MessageEmbed.Field;
 import net.dv8tion.jda.api.entities.Role;
-import net.dv8tion.jda.api.entities.User;
 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;
@@ -18,6 +17,8 @@
 import net.dv8tion.jda.api.interactions.commands.build.SubcommandData;
 import net.dv8tion.jda.api.interactions.components.ActionRow;
 import net.dv8tion.jda.api.interactions.components.buttons.Button;
+import net.dv8tion.jda.api.utils.FileUpload;
+import net.dv8tion.jda.api.utils.messages.MessageEditBuilder;
 import net.javadiscord.javabot.annotations.AutoDetectableComponentHandler;
 import net.javadiscord.javabot.systems.help.dao.HelpAccountRepository;
 import net.javadiscord.javabot.systems.help.dao.HelpTransactionRepository;
@@ -28,7 +29,9 @@
 import org.jetbrains.annotations.NotNull;
 import org.springframework.dao.DataAccessException;
 
+import java.io.IOException;
 import java.util.List;
+import java.util.Objects;
 import java.util.concurrent.ExecutorService;
 import java.util.function.BiFunction;
 
@@ -37,7 +40,12 @@
  */
 @AutoDetectableComponentHandler("experience-leaderboard")
 public class ExperienceLeaderboardSubcommand extends SlashCommand.Subcommand implements ButtonHandler {
-	private static final int PAGE_SIZE = 5;
+	/**
+	 * prefix contained in the image cache.
+	 */
+	public static final String CACHE_PREFIX = "xp_leaderboard";
+	private static final int PAGE_SIZE = 10;
+
 	private final ExecutorService asyncPool;
 	private final HelpAccountRepository helpAccountRepository;
 	private final HelpTransactionRepository helpTransactionRepository;
@@ -90,58 +98,74 @@ public void handleButton(@NotNull ButtonInteractionEvent event, Button button) {
 				if (page > maxPage) {
 					page = 1;
 				}
+				Pair<MessageEmbed, FileUpload> messageInfo = buildExperienceLeaderboard(event.getGuild(), page, type);
 				event.getHook()
-						.editOriginalEmbeds(buildExperienceLeaderboard(event.getGuild(), page, type))
+						.editOriginal(new MessageEditBuilder().setEmbeds(messageInfo.first()).setAttachments(messageInfo.second()).build())
 						.setComponents(buildPageControls(page, type)).queue();
-			} catch (DataAccessException e) {
+			} catch (DataAccessException | IOException e) {
 				ExceptionLogger.capture(e, ExperienceLeaderboardSubcommand.class.getSimpleName());
 			}
 		});
 	}
 
 
-	private @NotNull MessageEmbed buildExperienceLeaderboard(Guild guild, int page, LeaderboardType type) throws DataAccessException {
+	private @NotNull Pair<MessageEmbed, FileUpload> buildExperienceLeaderboard(Guild guild, int page, LeaderboardType type) throws DataAccessException, IOException {
 		return switch (type) {
 			case TOTAL -> buildGenericExperienceLeaderboard(page, helpAccountRepository.getTotalAccounts(),
 					"total Leaderboard of help experience",
 					helpAccountRepository::getAccounts, (position, account) -> {
 				Pair<Role, Double> currentRole = account.getCurrentExperienceGoal(guild);
-				return buildEmbed(guild, position, account.getExperience(), account.getUserId(), currentRole.first() != null ? currentRole.first().getAsMention() + ": " : "");
+				return createUserData(guild, position, account.getExperience(), account.getUserId(), currentRole.first() != null ? currentRole.first().getAsMention() + ": " : "");
 			});
 			case MONTH -> buildGenericExperienceLeaderboard(page, helpTransactionRepository.getNumberOfUsersWithHelpXPInLastMonth(),
 					"""
 					help experience leaderboard from the last 30 days
 					This leaderboard does not include experience decay.
 					""",
 					helpTransactionRepository::getTotalTransactionWeightsInLastMonth, (position, xpInfo) -> {
-				return buildEmbed(guild, position, (double) xpInfo.second(), xpInfo.first(), "");
+				return createUserData(guild, position, (double) xpInfo.second(), xpInfo.first(), "");
 			});
 		};
 	}
 
-	private <T> @NotNull MessageEmbed buildGenericExperienceLeaderboard(int page, int totalAccounts, String description,
-			BiFunction<Integer, Integer, List<T>> accountsReader, BiFunction<Integer, T, MessageEmbed.Field> fieldExtractor) throws DataAccessException {
+	private <T> @NotNull Pair<MessageEmbed, FileUpload> buildGenericExperienceLeaderboard(int page, int totalAccounts, String description,
+			BiFunction<Integer, Integer, List<T>> accountsReader, BiFunction<Integer, T, UserData> fieldExtractor) throws DataAccessException, IOException {
+
 		int maxPage = totalAccounts / PAGE_SIZE;
 		int actualPage = Math.max(1, Math.min(page, maxPage));
 		List<T> accounts = accountsReader.apply(actualPage, PAGE_SIZE);
+
 		EmbedBuilder builder = new EmbedBuilder()
 				.setTitle("Experience Leaderboard")
 				.setDescription(description)
 				.setColor(Responses.Type.DEFAULT.getColor())
 				.setFooter(String.format("Page %s/%s", actualPage, maxPage));
-		for (int i = 0; i < accounts.size(); i++) {
-			int position = (i + 1) + (actualPage - 1) * PAGE_SIZE;
-			builder.addField(fieldExtractor.apply(position, accounts.get(i)));
-		}
-		return builder.build();
+
+		String pageCachePrefix = CACHE_PREFIX + "_" + page;
+		String cacheName = pageCachePrefix + "_" + accounts.hashCode();
+		byte[] bytes = LeaderboardCreator.attemptLoadFromCache(cacheName, ()->{
+			try (LeaderboardCreator creator = new LeaderboardCreator(accounts.size(), null)){
+				for (int i = 0; i < accounts.size(); i++) {
+					int position = (i + 1) + (actualPage - 1) * PAGE_SIZE;
+					UserData userInfo = fieldExtractor.apply(position, accounts.get(i));
+					creator.drawLeaderboardEntry(userInfo.member(), userInfo.displayName(), userInfo.xp(), position);
+				}
+				return creator.getImageBytes(cacheName, pageCachePrefix);
+			}
+		});
+		builder.setImage("attachment://leaderboard.png");
+		return new Pair<MessageEmbed, FileUpload>(builder.build(), FileUpload.fromData(bytes, "leaderboard.png"));
 	}
 
-	private Field buildEmbed(Guild guild, Integer position, double experience, long userId, String prefix) {
-		User user = guild.getJDA().getUserById(userId);
-		return new MessageEmbed.Field(
-				String.format("**%s.** %s", position, user == null ? userId : UserUtils.getUserTag(user)),
-				String.format("%s`%.0f XP`\n", prefix, experience),
-				false);
+	private UserData createUserData(Guild guild, Integer position, double experience, long userId, String prefix) {
+		Member member = guild.getMemberById(userId);
+		String displayName;
+		if (member == null) {
+			displayName = String.valueOf(userId);
+		} else {
+			displayName = UserUtils.getUserTag(member.getUser());
+		}
+		return new UserData(member, displayName, (long)experience);
 	}
 
 	@Contract("_ -> new")
@@ -159,10 +183,12 @@ public void execute(@NotNull SlashCommandInteractionEvent event) {
 		event.deferReply().queue();
 		asyncPool.execute(() -> {
 			try {
-				event.getHook().sendMessageEmbeds(buildExperienceLeaderboard(event.getGuild(), page, type))
+				Pair<MessageEmbed, FileUpload> messageInfo = buildExperienceLeaderboard(event.getGuild(), page, type);
+				event.getHook().sendMessageEmbeds(messageInfo.first())
+					.addFiles(messageInfo.second())
 					.setComponents(buildPageControls(page, type))
 					.queue();
-			}catch (DataAccessException e) {
+			}catch (DataAccessException | IOException e) {
 				ExceptionLogger.capture(e, ExperienceLeaderboardSubcommand.class.getSimpleName());
 			}
 		});
@@ -171,4 +197,10 @@ public void execute(@NotNull SlashCommandInteractionEvent event) {
 	private enum LeaderboardType{
 		TOTAL, MONTH
 	}
+
+	private record UserData(Member member, String displayName, long xp) {
+		UserData {
+			Objects.requireNonNull(displayName);
+		}
+	}
 }

src/main/java/net/javadiscord/javabot/systems/user_commands/leaderboard/LeaderboardCreator.java

@@ -0,0 +1,167 @@
+package net.javadiscord.javabot.systems.user_commands.leaderboard;
+
+import java.awt.Color;
+import java.awt.Font;
+import java.awt.Graphics2D;
+import java.awt.RenderingHints;
+import java.awt.image.BufferedImage;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+
+import javax.imageio.ImageIO;
+
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import net.dv8tion.jda.api.entities.Member;
+import net.javadiscord.javabot.util.ImageCache;
+import net.javadiscord.javabot.util.ImageGenerationUtils;
+
+/**
+ * Creates graphical leaderboards.
+ */
+class LeaderboardCreator implements AutoCloseable{
+
+	private static final Color PRIMARY_COLOR = Color.WHITE;
+	private static final Color SECONDARY_COLOR = Color.decode("#414A52");
+	private static final int MARGIN = 40;
+	/**
+	 * The image's width.
+	 */
+	private static final int WIDTH = 3000;
+
+	private static final Color BACKGROUND_COLOR = Color.decode("#011E2F");
+	private Graphics2D g2d;
+	private int y;
+	private boolean left;
+	private BufferedImage image;
+
+	/**
+	 * Prepares drawing a leaderboard.
+	 * @param numberOfEntries the number of entries in the leaderboard
+	 * @param logoName the name of the logo put at the top of the leaderboard or {@code null} if no logo shall be used
+	 * @throws IOException if anything goes wrong
+	 */
+	LeaderboardCreator(int numberOfEntries, String logoName) throws IOException{
+
+		int logoHeight = 0;
+		BufferedImage logo = null;
+		if (logoName != null) {
+			logo = ImageGenerationUtils.getResourceImage("assets/images/" + logoName + ".png");
+			logoHeight = logo.getHeight();
+		}
+
+		int height = (logoHeight + MARGIN * 3) +
+				(ImageGenerationUtils.getResourceImage("assets/images/LeaderboardUserCard.png").getHeight() + MARGIN) * ((int)Math.ceil(numberOfEntries / 2f)) + MARGIN;
+		image = new BufferedImage(WIDTH, height, BufferedImage.TYPE_INT_RGB);
+		g2d = image.createGraphics();
+
+		g2d.setRenderingHint(RenderingHints.KEY_TEXT_ANTIALIASING, RenderingHints.VALUE_TEXT_ANTIALIAS_LCD_HRGB);
+		g2d.setRenderingHint(RenderingHints.KEY_FRACTIONALMETRICS, RenderingHints.VALUE_FRACTIONALMETRICS_ON);
+		g2d.setPaint(BACKGROUND_COLOR);
+		g2d.fillRect(0, 0, WIDTH, height);
+		if (logo != null) {
+			g2d.drawImage(logo, WIDTH / 2 - logo.getWidth() / 2, MARGIN, null);
+		}
+
+		left = true;
+		y = logoHeight + 3 * MARGIN;
+	}
+
+	/**
+	 * adds a single entry in the leaderboard.
+	 * @param member the {@link Member} this entry is responsible for or {@code null} if no member can be associated
+	 * @param displayName the name to display
+	 * @param points the amount of points
+	 * @param rankNumber the rank of the given user
+	 * @throws IOException if anything goes wrong
+	 */
+	public void drawLeaderboardEntry(@Nullable Member member, @NotNull String displayName, long points, int rankNumber) throws IOException {
+		BufferedImage card = ImageGenerationUtils.getResourceImage("assets/images/LeaderboardUserCard.png");
+		int x = left ? MARGIN * 5 : WIDTH - MARGIN * 5 - card.getWidth();
+		if (member != null) {
+			g2d.drawImage(ImageGenerationUtils.getImageFromUrl(member.getEffectiveAvatarUrl() + "?size=4096"), x + 185, y + 43, 200, 200, null);
+		}
+		// draw card
+		g2d.drawImage(card, x, y, null);
+		g2d.setColor(PRIMARY_COLOR);
+		g2d.setFont(ImageGenerationUtils.getResourceFont("assets/fonts/Uni-Sans-Heavy.ttf", 65).orElseThrow());
+
+		int stringWidth = g2d.getFontMetrics().stringWidth(displayName);
+		while (stringWidth > 750) {
+			Font currentFont = g2d.getFont();
+			Font newFont = currentFont.deriveFont(currentFont.getSize() - 1F);
+			g2d.setFont(newFont);
+			stringWidth = g2d.getFontMetrics().stringWidth(displayName);
+		}
+		g2d.drawString(displayName, x + 430, y + 130);
+		g2d.setColor(SECONDARY_COLOR);
+		g2d.setFont(ImageGenerationUtils.getResourceFont("assets/fonts/Uni-Sans-Heavy.ttf", 72).orElseThrow());
+
+		String text = points + (points > 1 ? " points" : " point");
+		String rank = "#" + rankNumber;
+		g2d.drawString(text, x + 430, y + 210);
+		int stringLength = (int) g2d.getFontMetrics().getStringBounds(rank, g2d).getWidth();
+		int start = 185 / 2 - stringLength / 2;
+		g2d.drawString(rank, x + start, y + 173);
+
+		left = !left;
+		if (left) y = y + card.getHeight() + MARGIN;
+	}
+
+	/**
+	 * convert the drawn image to a {@code byte[]}.
+	 *
+	 * This also caches the image and invalidates all caches matching {@code invalidateCacheKeyword}
+	 * @param cacheName the name of the cache where the image should be cached
+	 * @param invalidateCacheKeyword all image caches containing this keyword will be invalidated, should be a substring of {@code cacheName}
+	 * @return the drawn image as a {@code byte[]}
+	 * @throws IOException if anything goes wrong
+	 */
+	public @NotNull byte[] getImageBytes(String cacheName, String invalidateCacheKeyword) throws IOException {
+		ImageCache.removeCachedImagesByKeyword(invalidateCacheKeyword);
+		ImageCache.cacheImage(cacheName, image);
+		try (ByteArrayOutputStream baos = getOutputStreamFromImage(image)) {
+			return baos.toByteArray();
+		}
+	}
+
+	/**
+	 * load an image from the cache as a {@code byte[]}.
+	 * @param cacheName the name of the cache to load
+	 * @param fallback a callback which is executed in case the cache could not be found
+	 * @return the cached image or the fallback image
+	 * @throws IOException if anything goes wrong
+	 */
+	public static byte[] attemptLoadFromCache(String cacheName, ByteArrayLoader fallback) throws IOException {
+		return ImageCache.isCached(cacheName) ?
+				// retrieve the image from the cache
+				getOutputStreamFromImage(ImageCache.getCachedImage(cacheName)).toByteArray() :
+				// generate an entirely new image
+				fallback.load();
+	}
+
+	/**
+	 * Retrieves the image's {@link ByteArrayOutputStream}.
+	 *
+	 * @param image The image.
+	 * @return The image's {@link ByteArrayOutputStream}.
+	 * @throws IOException If an error occurs.
+	 */
+	private static @NotNull ByteArrayOutputStream getOutputStreamFromImage(BufferedImage image) throws IOException {
+		ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
+		ImageIO.write(image, "png", outputStream);
+		return outputStream;
+	}
+
+	@Override
+	public void close() {
+		g2d.dispose();
+	}
+
+	@FunctionalInterface
+	interface ByteArrayLoader{
+		byte[] load() throws IOException;
+	}
+
+}