Banlist plugin update (#435)

* Banlist plugin update

Uses enum instead of int to check list type

Added ability (and config) to highlight scammers name red
![alt text](https://i.gyazo.com/0d21af62a1f697fb994ebd2a957576e7.png)
![alt text](https://i.gyazo.com/a2bef037dc891b88ddb58d8419a7e1d1.png)

* config checkstyle

runelite-client/src/main/java/net/runelite/client/plugins/banlist/BanListConfig.java

@@ -50,4 +50,26 @@ public interface BanListConfig extends Config
 		return true;
 	}
 
+	@ConfigItem(
+			position = 3,
+			keyName = "highlightInClan",
+			name = "Highlight red in Clan Chat",
+			description = "Highlights Scammer\'s name in your current clan chat."
+	)
+	default boolean highlightInClan()
+	{
+		return true;
+	}
+
+	@ConfigItem(
+			position = 4,
+			keyName = "highlightInTrade",
+			name = "Highlight red in trade screen",
+			description = "Highlights Scammer\'s name in your trade window"
+	)
+	default boolean highlightInTrade()
+	{
+		return true;
+	}
+
 }

runelite-client/src/main/java/net/runelite/client/plugins/banlist/BanListPlugin.java

@@ -1,7 +1,7 @@
 /*
  * Copyright (c) 2019, xperiaclash <https://github.com/xperiaclash>
  * Copyright (c) 2019, ganom <https://github.com/Ganom>
-
+ * Copyright (c) 2019, gazivodag <https://github.com/gazivodag>
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -31,12 +31,17 @@ import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Arrays;
 import javax.inject.Inject;
-import static jdk.nashorn.internal.runtime.regexp.joni.Config.log;
+import lombok.extern.slf4j.Slf4j;
 import net.runelite.api.ChatMessageType;
 import net.runelite.api.ClanMember;
 import net.runelite.api.Client;
 import net.runelite.api.events.ClanMemberJoined;
 import net.runelite.api.events.ConfigChanged;
+import net.runelite.api.events.WidgetHiddenChanged;
+import net.runelite.api.events.WidgetLoaded;
+import net.runelite.api.widgets.Widget;
+import net.runelite.api.widgets.WidgetInfo;
+import net.runelite.client.callback.ClientThread;
 import net.runelite.client.chat.ChatColorType;
 import net.runelite.client.chat.ChatMessageBuilder;
 import net.runelite.client.chat.ChatMessageManager;
@@ -60,11 +65,15 @@ import okhttp3.Response;
 		tags = {"PVM", "WDR", "RuneWatch"},
 		type = PluginType.UTILITY
 )
+@Slf4j
 public class BanListPlugin extends Plugin
 {
 	@Inject
 	private Client client;
 
+	@Inject
+	private ClientThread clientThread;
+
 	@Inject
 	private BanListConfig config;
 
@@ -96,13 +105,6 @@ public class BanListPlugin extends Plugin
 		manualBans.clear();
 	}
 
-	@Subscribe
-	public void onClanMemberJoined(ClanMemberJoined event)
-	{
-		ClanMember member = event.getMember();
-		checkBanList(Text.standardize(member.getUsername()));
-	}
-
 	@Subscribe
 	public void onConfigChanged(ConfigChanged event)
 	{
@@ -121,83 +123,150 @@ public class BanListPlugin extends Plugin
 		}
 	}
 
-	private void checkBanList(String nameToBeChecked)
+	/**
+	 * Event to keep making sure player names are highlighted red in clan chat, since the red name goes away frequently
+	 *
+	 * @param widgetHiddenChanged
+	 */
+	@Subscribe
+	public void onWidgetHiddenChanged(WidgetHiddenChanged widgetHiddenChanged)
 	{
-		if (client.getClanMembers() != null)
+		if (config.highlightInClan())
 		{
-			if (wdrArrayList.size() > 0 && config.enableWDR())
+			clientThread.invokeLater(() ->
 			{
-				if (wdrArrayList.stream().anyMatch(nameToBeChecked::equalsIgnoreCase))
+				if (!client.getWidget(WidgetInfo.CLAN_CHAT).isHidden())
 				{
-					sendWarning(nameToBeChecked, 1);
+					highlightRedInCC();
 				}
-			}
+			});
+		}
+	}
 
-			if (runeWatchArrayList.size() > 0 && config.enableRuneWatch())
+	@Subscribe
+	public void onClanMemberJoined(ClanMemberJoined event)
+	{
+		ClanMember member = event.getMember();
+		ListType listType = checkBanList(Text.standardize(member.getUsername()));
+		if (listType != null)
+		{
+			sendWarning(Text.standardize(member.getUsername()), listType);
+			if (config.highlightInClan())
 			{
-				if (runeWatchArrayList.stream().anyMatch(nameToBeChecked::equalsIgnoreCase))
+				highlightRedInCC();
-				{
-					sendWarning(nameToBeChecked, 2);
-				}
-			}
-
-			if (manualBans.size() > 0)
-			{
-				if (manualBans.stream().anyMatch(nameToBeChecked::equalsIgnoreCase))
-				{
-					sendWarning(nameToBeChecked, 3);
-				}
 			}
 		}
 	}
 
-	private void sendWarning(String playerName, int list)
+	/**
+	 * If a trade window is opened and the person trading us is on the list, modify "trading with"
+	 */
+	@Subscribe
+	public void onWidgetLoaded(WidgetLoaded widgetLoaded)
 	{
-		if (list == 1)
+		if (config.highlightInTrade())
 		{
-			// on wdr list
+			if (widgetLoaded.getGroupId() == 335)
-			final String message = new ChatMessageBuilder()
+			{ //if trading window was loaded
-					.append(ChatColorType.HIGHLIGHT)
+				clientThread.invokeLater(() ->
-					.append("Warning! " + playerName + " is on WDRs' scammer list")
+				{
-					.build();
+					Widget tradingWith = client.getWidget(335, 31);
-
+					String name = tradingWith.getText().replaceAll("Trading With: ", "");
-			chatMessageManager.queue(
+					if (checkBanList(name) != null)
-					QueuedMessage.builder()
+					{
-							.type(ChatMessageType.CONSOLE)
+						tradingWith.setText(tradingWith.getText().replaceAll(name, "<col=ff0000>" + name + " (Scammer)" + "</col>"));
-							.runeLiteFormattedMessage(message)
+					}
-							.build());
+				});
-		}
+			}
-		else if (list == 2)
-		{
-			// on runewatch list
-			final String message = new ChatMessageBuilder()
-					.append(ChatColorType.HIGHLIGHT)
-					.append("Warning! " + playerName + " is on Runewatchs' scammer list")
-					.build();
-
-			chatMessageManager.queue(
-					QueuedMessage.builder()
-							.type(ChatMessageType.CONSOLE)
-							.runeLiteFormattedMessage(message)
-							.build());
-		}
-		else if (list == 3)
-		{
-			// on manual list
-			final String message = new ChatMessageBuilder()
-					.append(ChatColorType.HIGHLIGHT)
-					.append("Warning! " + playerName + " is on your Manual scammer list")
-					.build();
-
-			chatMessageManager.queue(
-					QueuedMessage.builder()
-							.type(ChatMessageType.CONSOLE)
-							.runeLiteFormattedMessage(message)
-							.build());
 		}
 	}
 
+	/**
+	 * Compares player name to everything in the ban lists
+	 *
+	 * @param nameToBeChecked
+	 */
+	private ListType checkBanList(String nameToBeChecked)
+	{
+		if (wdrArrayList.size() > 0 && config.enableWDR())
+		{
+			if (wdrArrayList.stream().anyMatch(nameToBeChecked::equalsIgnoreCase))
+			{
+				return ListType.WEDORAIDS_LIST;
+			}
+		}
 
+		if (runeWatchArrayList.size() > 0 && config.enableRuneWatch())
+		{
+			if (runeWatchArrayList.stream().anyMatch(nameToBeChecked::equalsIgnoreCase))
+			{
+				return ListType.RUNEWATCH_LIST;
+			}
+		}
+
+		if (manualBans.size() > 0)
+		{
+			if (manualBans.stream().anyMatch(nameToBeChecked::equalsIgnoreCase))
+			{
+				return ListType.MANUAL_LIST;
+			}
+		}
+
+		return null;
+	}
+
+	/**
+	 * Sends a warning to our player, notifying them that a player is on a ban list
+	 *
+	 * @param playerName
+	 * @param listType
+	 */
+	private void sendWarning(String playerName, ListType listType)
+	{
+		switch (listType)
+		{
+			case WEDORAIDS_LIST:
+				final String wdr_message = new ChatMessageBuilder()
+						.append(ChatColorType.HIGHLIGHT)
+						.append("Warning! " + playerName + " is on WeDoRaids\' scammer list!")
+						.build();
+
+				chatMessageManager.queue(
+						QueuedMessage.builder()
+								.type(ChatMessageType.CONSOLE)
+								.runeLiteFormattedMessage(wdr_message)
+								.build());
+				break;
+			case RUNEWATCH_LIST:
+				final String rw_message = new ChatMessageBuilder()
+						.append(ChatColorType.HIGHLIGHT)
+						.append("Warning! " + playerName + " is on the Runewatch\'s scammer list!")
+						.build();
+
+				chatMessageManager.queue(
+						QueuedMessage.builder()
+								.type(ChatMessageType.CONSOLE)
+								.runeLiteFormattedMessage(rw_message)
+								.build());
+				break;
+			case MANUAL_LIST:
+				final String manual_message = new ChatMessageBuilder()
+						.append(ChatColorType.HIGHLIGHT)
+						.append("Warning! " + playerName + " is on your manual scammer list!")
+						.build();
+
+				chatMessageManager.queue(
+						QueuedMessage.builder()
+								.type(ChatMessageType.CONSOLE)
+								.runeLiteFormattedMessage(manual_message)
+								.build());
+				break;
+		}
+	}
+
+	/**
+	 * Pulls data from wdr and runewatch to build a list of blacklisted usernames
+	 */
 	private void fetchFromWebsites()
 	{
 		Request request = new Request.Builder()
@@ -208,7 +277,7 @@ public class BanListPlugin extends Plugin
 			@Override
 			public void onFailure(Call call, IOException e)
 			{
-				log.println("error retrieving names from wdr");
+				log.debug("error retrieving names from wdr");
 			}
 
 			@Override
@@ -236,7 +305,7 @@ public class BanListPlugin extends Plugin
 			@Override
 			public void onFailure(Call call, IOException e)
 			{
-				log.println("error retrieving names from runewatch");
+				log.debug("error retrieving names from runewatch");
 			}
 
 			@Override
@@ -257,4 +326,24 @@ public class BanListPlugin extends Plugin
 			}
 		});
 	}
+
+	/**
+	 * Iterates through the clan chat list widget and checks if a string (name) is on any of the ban lists to highlight them red.
+	 */
+	private void highlightRedInCC()
+	{
+		clientThread.invokeLater(() ->
+		{
+			Widget widget = client.getWidget(WidgetInfo.CLAN_CHAT_LIST);
+			for (Widget widgetChild : widget.getDynamicChildren())
+			{
+				ListType listType = checkBanList(widgetChild.getText());
+
+				if (listType != null)
+				{
+					widgetChild.setText("<col=ff0000>" + widgetChild.getText() + "</col>");
+				}
+			}
+		});
+	}
 }

runelite-client/src/main/java/net/runelite/client/plugins/banlist/ListType.java

@@ -0,0 +1,8 @@
+package net.runelite.client.plugins.banlist;
+
+public enum ListType
+{
+	WEDORAIDS_LIST,
+	RUNEWATCH_LIST,
+	MANUAL_LIST
+}