Add PAPI support

Author: Dieter Nuytemans

pom.xml

@@ -16,10 +16,16 @@
 
 
     <repositories>
+        <!-- Spigot -->
         <repository>
             <id>spigot-repo</id>
             <url>https://hub.spigotmc.org/nexus/content/repositories/snapshots/</url>
         </repository>
+        <!-- PAPI -->
+        <repository>
+            <id>placeholderapi</id>
+            <url>http://repo.extendedclip.com/content/repositories/placeholderapi/</url>
+        </repository>
     </repositories>
 
     <dependencies>
@@ -30,6 +36,13 @@
             <version>1.17-R0.1-SNAPSHOT</version>
             <scope>provided</scope>
         </dependency>
+        <!-- PAPI -->
+        <dependency>
+            <groupId>me.clip</groupId>
+            <artifactId>placeholderapi</artifactId>
+            <version>2.10.9</version>
+            <scope>provided</scope>
+        </dependency>
         <!-- Mockito -->
         <dependency>
             <groupId>org.mockito</groupId>

src/main/java/be/betterplugins/core/messaging/messenger/Messenger.java

@@ -1,6 +1,9 @@
 package be.betterplugins.core.messaging.messenger;
 
 import be.betterplugins.core.messaging.logging.BPLogger;
+import be.betterplugins.core.messaging.messenger.placeholderapi.IPapiUtil;
+import be.betterplugins.core.messaging.messenger.placeholderapi.NoPapiUtil;
+import be.betterplugins.core.messaging.messenger.placeholderapi.PapiUtil;
 import org.apache.commons.lang.StringUtils;
 import org.bukkit.Bukkit;
 import org.bukkit.ChatColor;
@@ -19,36 +22,44 @@ public class Messenger
     private final String prefix;
     private final BPLogger logger;
 
+    private final IPapiUtil papiUtil;
+
     /**
-     * Creates a messenger for player output
-     * @param messages the messages from lang.yml, mapping path to message
-     * @param prefix the prefix for all messages
+     * Creates a messenger for player output.
+     *
+     * @param messages the messages from lang.yml, mapping path to message.
+     * @param prefix the prefix for all messages.
      */
     public Messenger(Map<String, String> messages, BPLogger logger, String prefix)
     {
         this.messages = messages;
         this.logger = logger;
         this.prefix = prefix;
+
+        boolean hasPapi = Bukkit.getPluginManager().getPlugin("PlaceholderAPI") != null;
+        this.papiUtil = hasPapi ? new PapiUtil() : new NoPapiUtil();
     }
 
 
     /**
-     * Compose a ready-to-be-sent BetterPlugin message
-     * @param messageID the ID of the message, or a custom message
-     * @param replacements the tag replacements for this message
-     * @return the message ready to be sent
+     * Compose a ready-to-be-sent BetterPlugin message.
+     *
+     * @param messageID the ID of the message, or a custom message.
+     * @param replacements the tag replacements for this message.
+     * @return the message ready to be sent.
      */
     public String composeMessage(String messageID, MsgEntry... replacements)
     {
         return this.composeMessage(messageID, true, replacements);
     }
 
     /**
-     * Compose a ready-to-be-sent BetterPlugin message
-     * @param messageID the ID of the message, or a custom message
-     * @param includePrefix whether or not a prefix should be put in front of this message
-     * @param replacements the tag replacements for this message
-     * @return the message ready to be sent
+     * Compose a ready-to-be-sent BetterPlugin message.
+     *
+     * @param messageID the ID of the message, or a custom message.
+     * @param includePrefix whether or not a prefix should be put in front of this message.
+     * @param replacements the tag replacements for this message.
+     * @return the message ready to be sent.
      */
     public String composeMessage(String messageID, boolean includePrefix, MsgEntry... replacements)
     {
@@ -118,13 +129,16 @@ else if (options.length >= 1)
 
 
     /**
-     * Send a message from lang.yml to a CommandSender
-     * If the message does not exist, it will be sent to the player in its raw form
-     * As optional parameter, a list or several MsgEntries can be given as parameter
-     * @param receiver the receiver
-     * @param messageID the id of the message
-     * @param replacements The strings that are to be replaced to allow using variables in messages
-     * @return False if this message is disabled (set to "" or "ignored"), true otherwise
+     * Send a message from lang.yml to a CommandSender.
+     * If the message does not exist, it will be sent to the player in its raw form.
+     * As optional parameter, a list or several MsgEntries can be given as parameter.
+     * Will automatically replace PAPI placeholders relative to the provided <player>-tag or each receiver if no <player>-tag is provided.
+     * To not replace placeholders, provide a MsgEntry that replaces <player> by null.
+     *
+     * @param receiver the receiver.
+     * @param messageID the id of the message.
+     * @param replacements The strings that are to be replaced to allow using variables in messages.
+     * @return False if this message is disabled (set to "" or "ignored"), true otherwise.
      */
     public boolean sendMessage(CommandSender receiver, String messageID, MsgEntry... replacements)
     {
@@ -134,13 +148,16 @@ public boolean sendMessage(CommandSender receiver, String messageID, MsgEntry...
 
 
     /**
-     * Send a message from lang.yml to a list of players
-     * If the message does not exist, it will be sent to the player in its raw form
-     * As optional parameter, a list or several MsgEntries can be given as parameter
-     * @param receivers the list of players
-     * @param messageID the id of the message
-     * @param replacements The strings that are to be replaced to allow using variables in messages
-     * @return False if this message is disabled (set to "" or "ignored"), true otherwise
+     * Send a message from lang.yml to a list of players.
+     * If the message does not exist, it will be sent to the player in its raw form.
+     * As optional parameter, a list or several MsgEntries can be given as parameter.
+     * Will automatically replace PAPI placeholders relative to the provided <player>-tag or each receiver if no <player>-tag is provided.
+     * To not replace placeholders, provide a MsgEntry that replaces <player> by null.
+     *
+     * @param receivers the list of players.
+     * @param messageID the id of the message.
+     * @param replacements The strings that are to be replaced to allow using variables in messages.
+     * @return False if this message is disabled (set to "" or "ignored"), true otherwise.
      */
     public boolean sendMessage(List<? extends CommandSender> receivers, String messageID, MsgEntry... replacements)
     {
@@ -151,23 +168,46 @@ public boolean sendMessage(List<? extends CommandSender> receivers, String messa
 
         // Get the player if there is a player who did an action
         Player placeholderPlayer = null;
+        boolean hasPlayerTag = false;
         for (MsgEntry entry : replacements)
+        {
             if (entry.getTag().equals("<player>"))
+            {
+                hasPlayerTag = true;
                 placeholderPlayer = Bukkit.getPlayer(entry.getReplacement());
+            }
+        }
 
+        // Replace PAPI placeholders with respect to the player that did an action
+        if (placeholderPlayer != null)
+        {
+            message = papiUtil.setPlaceholders( placeholderPlayer, message );
+        }
 
         // Send everyone a message
         for (CommandSender receiver : receivers)
         {
-            // Get the senders name
+            // Get the senders name and replace <user> tags
             String name = receiver.getName();
             String finalMessage = message.replace("<user>", ChatColor.stripColor( name ));
+
+            // Use PAPI to replace messages. ONLY When no <player> tag was provided
+            if (!hasPlayerTag && receiver instanceof Player)
+            {
+                Player player = (Player) receiver;
+                finalMessage = papiUtil.setPlaceholders( player, finalMessage );
+            }
+
+            // Send the message
             sendMessage(receiver, finalMessage);
         }
 
         return true;
     }
 
+    /**
+     * Used so the method of sending can be overridden
+     */
     protected void sendMessage(CommandSender receiver, String message)
     {
         receiver.sendMessage( message );

src/main/java/be/betterplugins/core/messaging/messenger/placeholderapi/IPapiUtil.java

@@ -0,0 +1,10 @@
+package be.betterplugins.core.messaging.messenger.placeholderapi;
+
+import org.bukkit.entity.Player;
+
+public interface IPapiUtil
+{
+
+    String setPlaceholders(Player player, String message);
+
+}

src/main/java/be/betterplugins/core/messaging/messenger/placeholderapi/NoPapiUtil.java

@@ -0,0 +1,12 @@
+package be.betterplugins.core.messaging.messenger.placeholderapi;
+
+import org.bukkit.entity.Player;
+
+public class NoPapiUtil implements IPapiUtil
+{
+    @Override
+    public String setPlaceholders(Player player, String message)
+    {
+        return message;
+    }
+}

src/main/java/be/betterplugins/core/messaging/messenger/placeholderapi/PapiUtil.java

@@ -0,0 +1,13 @@
+package be.betterplugins.core.messaging.messenger.placeholderapi;
+
+import me.clip.placeholderapi.PlaceholderAPI;
+import org.bukkit.entity.Player;
+
+public class PapiUtil implements IPapiUtil
+{
+    @Override
+    public String setPlaceholders(Player player, String message)
+    {
+        return PlaceholderAPI.setPlaceholders( player, message );
+    }
+}