Added name check and change system (#280)

* Fix MessageCacheListener when direct message is received

* Added name check and change system

* Fixed Checkstyle

* Made Dynxsty's Changes

* Made other changes

* Made requested changes

Co-Authored-By: Dynxsty <dynxsty@javadiscord.net>
Co-Authored-By: dan1st <34687786+danthe1st@users.noreply.github.com>

* Re-added canBypassCheck

* Use Scanner for readStrings

* Fix checkstyle

Co-authored-by: Dynxsty <dynxsty@javadiscord.net>
Co-authored-by: dan1st <34687786+danthe1st@users.noreply.github.com>

Author: 3 people

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

@@ -141,7 +141,8 @@ private static void addEventListeners(JDA jda) {
 				new InteractionListener(),
 				new HelpChannelListener(),
 				new ShareKnowledgeVoteListener(),
-				new JobChannelVoteListener()
+				new JobChannelVoteListener(),
+				new PingableNameListener()
 		);
 	}
 }

src/main/java/net/javadiscord/javabot/data/h2db/message_cache/MessageCacheListener.java

@@ -67,8 +67,9 @@ public void onMessageDelete(@NotNull MessageDeleteEvent event) {
 	 * @return true if any of the criteria above apply
 	 */
 	private boolean ignoreMessageCache(Message message) {
+		if (!message.isFromGuild()) return true;
 		MessageCacheConfig config = Bot.config.get(message.getGuild()).getMessageCache();
-		return !message.isFromGuild() || message.getAuthor().isBot() || message.getAuthor().isSystem() ||
+		return message.getAuthor().isBot() || message.getAuthor().isSystem() ||
 				config.getExcludedUsers().contains(message.getAuthor().getIdLong()) ||
 				config.getExcludedChannels().contains(message.getChannel().getIdLong());
 	}

src/main/java/net/javadiscord/javabot/listener/PingableNameListener.java

@@ -0,0 +1,127 @@
+package net.javadiscord.javabot.listener;
+
+import lombok.extern.slf4j.Slf4j;
+import net.dv8tion.jda.api.entities.Member;
+import net.dv8tion.jda.api.events.guild.member.GuildMemberJoinEvent;
+import net.dv8tion.jda.api.events.guild.member.update.GuildMemberUpdateNicknameEvent;
+import net.dv8tion.jda.api.hooks.ListenerAdapter;
+import net.javadiscord.javabot.systems.notification.GuildNotificationService;
+import net.javadiscord.javabot.util.StringUtils;
+
+import java.io.IOException;
+import java.net.URL;
+import java.util.*;
+import java.util.stream.Collectors;
+
+/**
+ * Checks User's names & nicknames and makes sure they're pingable.
+ */
+@Slf4j
+public class PingableNameListener extends ListenerAdapter {
+
+	private static final String ADJECTIVES_URL = "https://gist.githubusercontent.com/karlbright/f91229b8c5ac6f4291dc/raw/4a69c2c50b88ee4559b021c443fee899535adc60/adjectives.txt";
+	private static final String NOUNS_URL = "https://raw.githubusercontent.com/hugsy/stuff/main/random-word/english-nouns.txt";
+	private static final Random random = new Random();
+	private final List<String> nouns;
+	private final List<String> adjectives;
+
+	/**
+	 * Constructs a new PingableNameListener and loads nouns & adjectives.
+	 */
+	public PingableNameListener() {
+		nouns = readStrings(NOUNS_URL);
+		adjectives = readStrings(ADJECTIVES_URL);
+		log.info("Loaded {} Nouns!", nouns.size());
+		log.info("Loaded {} Adjectives!", adjectives.size());
+	}
+
+	@Override
+	public void onGuildMemberJoin(GuildMemberJoinEvent event) {
+		checkNickname(event.getMember(), null);
+	}
+
+	@Override
+	public void onGuildMemberUpdateNickname(GuildMemberUpdateNicknameEvent event) {
+		checkNickname(event.getMember(), event.getNewNickname());
+	}
+
+	/**
+	 * Checks whether the given {@link Member}'s nickname should be changed.
+	 * @param member The {@link Member} to check.
+	 * @param nickname The {@link Member}'s new Nickname, null if that does not exist.
+	 */
+	private void checkNickname(Member member, String nickname) {
+		if (!(nickname==null||isPingable(nickname)) && !isPingable(member.getUser().getName()) && !canBypassCheck(member)) {
+			changeName(member);
+		}
+	}
+
+	/**
+	 * Changes the given {@link Member}s name to a randomly generated one.
+	 * @param member The Member whose name should be changed.
+	 */
+	private void changeName(Member member) {
+		String oldName = member.getNickname();
+		String newName = generateRandomName();
+		member.modifyNickname(newName.substring(0, Math.min(31, newName.length()))).queue();
+		member.getUser().openPrivateChannel()
+				.flatMap(channel -> channel.sendMessageFormat("Your nickname has been set to `%s` since both your user- and nickname's first three characters were deemed as not-pingable.", newName))
+				.queue();
+		new GuildNotificationService(member.getGuild()).sendLogChannelNotification("Changed %s's nickname from `%s` to `%s`.", member.getAsMention(), oldName, newName);
+	}
+
+	/**
+	 * Checks if the given name's first three characters contain ASCII characters not between 32 and 126.
+	 * @param name The name to check.
+	 * @return True if first three characters contain invalid characters, False if not.
+	 */
+	private boolean isPingable(String name) {
+		if (name == null) return true;
+		char[] nameChars = name.toCharArray();
+		for (int i = 0; i < Math.min(2,name.length()); i++) {
+			char c = nameChars[i];
+			if (c < 32 || c > 126) {
+				return false;
+			}
+		}
+		return true;
+	}
+
+	/**
+	 * Generates a random name consisting of a noun, an adjective and a number from 1 to 9999.
+	 * @return The generated name.
+	 */
+	private String generateRandomName() {
+		String noun = nouns.get(random.nextInt(nouns.size()));
+		String adjective = adjectives.get(random.nextInt(adjectives.size()));
+		int number = random.nextInt(10000);
+		return StringUtils.capitalize(adjective) + StringUtils.capitalize(noun) + number;
+	}
+
+	/**
+	 * Reads strings from the given URL to a {@link List}, removes words with a dash.
+	 * @param url The URL to read.
+	 * @return A {@link List} of Strings.
+	 */
+	private static List<String> readStrings(String url) {
+		List<String> list;
+		try (Scanner scan = new Scanner(new URL(url).openStream()).useDelimiter("\\n")) {
+			list = scan.tokens().collect(Collectors.toList());
+		} catch (IOException e) {
+			log.error("Error during retrieval of words.");
+			list = new ArrayList<>();
+		}
+
+		list.removeIf(word -> word.contains("-"));
+		return list;
+	}
+
+	/**
+	 * Checks if the given {@link Member} can bypass the name-check.
+	 * @param member The {@link Member} to check.
+	 * @return Whether the Member can bypass name-checks or not.
+	 */
+	private static boolean canBypassCheck(Member member) {
+		return member.getUser().isBot() || member.getUser().isSystem() || member.getGuild().getSelfMember().canInteract(member);
+	}
+}

src/main/java/net/javadiscord/javabot/util/StringUtils.java

@@ -70,4 +70,15 @@ public static String buildProgressBar(double current, double max, String off, St
 		int onLength = (int) (length * percent);
 		return on.repeat(onLength) + off.repeat(length - onLength);
 	}
+
+	/**
+	 * Capitalizes the given word.
+	 *
+	 * @param word The word to capitalize.
+	 * @return The capitalized word.
+	 */
+	public static String capitalize(String word) {
+		if (word == null || word.isEmpty()) return word;
+		return word.substring(0, 1).toUpperCase() + word.substring(1);
+	}
 }