Code cleanup to ChatEvent.

pom.xml

@@ -3,7 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.onarandombox.multiversecore</groupId>
     <artifactId>Multiverse-Core</artifactId>
-    <version>5.0.0-SNAPSHOT</version>
+    <version>4.2.3-SNAPSHOT</version>
     <name>Multiverse-Core</name>
     <description>World Management Plugin</description>
     <properties>
@@ -319,7 +319,7 @@
         <dependency>
             <groupId>org.bstats</groupId>
             <artifactId>bstats-bukkit</artifactId>
-            <version>1.8</version>
+            <version>1.7</version>
             <exclusions>
                 <exclusion>
                     <groupId>org.bukkit</groupId>

src/main/java/com/onarandombox/MultiverseCore/MultiverseCore.java

@@ -77,9 +77,11 @@ import com.onarandombox.MultiverseCore.destination.PlayerDestination;
 import com.onarandombox.MultiverseCore.destination.WorldDestination;
 import com.onarandombox.MultiverseCore.event.MVDebugModeEvent;
 import com.onarandombox.MultiverseCore.event.MVVersionEvent;
+import com.onarandombox.MultiverseCore.listeners.MVAsyncPlayerChatListener;
 import com.onarandombox.MultiverseCore.listeners.MVChatListener;
 import com.onarandombox.MultiverseCore.listeners.MVEntityListener;
 import com.onarandombox.MultiverseCore.listeners.MVMapListener;
+import com.onarandombox.MultiverseCore.listeners.MVPlayerChatListener;
 import com.onarandombox.MultiverseCore.listeners.MVPlayerListener;
 import com.onarandombox.MultiverseCore.listeners.MVPortalListener;
 import com.onarandombox.MultiverseCore.listeners.MVWeatherListener;
@@ -218,7 +220,7 @@ public class MultiverseCore extends JavaPlugin implements MVPlugin, Core {
     private final MVWeatherListener weatherListener = new MVWeatherListener(this);
     private final MVPortalListener portalListener = new MVPortalListener(this);
     private final MVWorldListener worldListener = new MVWorldListener(this);
-    private MVChatListener chatListener = new MVChatListener(this, this.playerListener);
+    private MVChatListener chatListener;
 
     // HashMap to contain information relating to the Players.
     private HashMap<String, MVPlayerSession> playerSessions;
@@ -316,6 +318,17 @@ public class MultiverseCore extends JavaPlugin implements MVPlugin, Core {
             // A test that had no worlds loaded was being run. This should never happen in production
         }
         this.saveMVConfig();
+        // Register async or sync player chat according to config
+        try {
+            Class.forName("org.bukkit.event.player.AsyncPlayerChatEvent");
+        } catch (ClassNotFoundException e) {
+            getMVConfig().setUseAsyncChat(false);
+        }
+        if (getMVConfig().getUseAsyncChat()) {
+            this.chatListener = new MVAsyncPlayerChatListener(this, this.playerListener);
+        } else {
+            this.chatListener = new MVPlayerChatListener(this, this.playerListener);
+        }
         getServer().getPluginManager().registerEvents(this.chatListener, this);
 
         this.initializeBuscript();
@@ -367,7 +380,6 @@ public class MultiverseCore extends JavaPlugin implements MVPlugin, Core {
     private void registerEvents() {
         PluginManager pm = getServer().getPluginManager();
         pm.registerEvents(this.playerListener, this);
-        pm.registerEvents(this.chatListener, this);
         pm.registerEvents(this.entityListener, this);
         pm.registerEvents(this.weatherListener, this);
         pm.registerEvents(this.portalListener, this);

src/main/java/com/onarandombox/MultiverseCore/MultiverseCoreConfiguration.java

@@ -48,6 +48,8 @@ public class MultiverseCoreConfiguration extends SerializationConfig implements
     @Property
     private volatile String prefixchatformat;
     @Property
+    private volatile boolean useasyncchat;
+    @Property
     private volatile boolean teleportintercept;
     @Property
     private volatile boolean firstspawnoverride;
@@ -91,6 +93,7 @@ public class MultiverseCoreConfiguration extends SerializationConfig implements
     protected void setDefaults() {
         // BEGIN CHECKSTYLE-SUPPRESSION: MagicNumberCheck
         enforceaccess = false;
+        useasyncchat = true;
         prefixchat = true;
         prefixchatformat = "[%world%]%chat%";
         teleportintercept = true;
@@ -300,6 +303,16 @@ public class MultiverseCoreConfiguration extends SerializationConfig implements
         this.teleportcooldown = teleportCooldown;
     }
 
+    @Override
+    public void setUseAsyncChat(boolean useAsyncChat) {
+        this.useasyncchat = useAsyncChat;
+    }
+
+    @Override
+    public boolean getUseAsyncChat() {
+        return this.useasyncchat;
+    }
+
     @Override
     public void setSilentStart(boolean silentStart) {
         Logging.setShowingConfig(!silentStart);

src/main/java/com/onarandombox/MultiverseCore/api/MultiverseCoreConfig.java

@@ -146,6 +146,18 @@ public interface MultiverseCoreConfig extends ConfigurationSerializable {
      */
     boolean getEnforceAccess();
 
+    /**
+     * Sets useasyncchat.
+     * @param useAsyncChat The new value.
+     */
+    void setUseAsyncChat(boolean useAsyncChat);
+
+    /**
+     * Gets useasyncchat.
+     * @return useasyncchat.
+     */
+    boolean getUseAsyncChat();
+
     /**
      * Sets whether to suppress startup messages.
      *

src/main/java/com/onarandombox/MultiverseCore/commands/VersionCommand.java

@@ -60,6 +60,7 @@ public class VersionCommand extends MultiverseCommand {
                 + "[Multiverse-Core]   enforceaccess: " + plugin.getMVConfig().getEnforceAccess() + '\n'
                 + "[Multiverse-Core]   prefixchat: " + plugin.getMVConfig().getPrefixChat() + '\n'
                 + "[Multiverse-Core]   prefixchatformat: " + plugin.getMVConfig().getPrefixChatFormat() + '\n'
+                + "[Multiverse-Core]   useasyncchat: " + plugin.getMVConfig().getUseAsyncChat() + '\n'
                 + "[Multiverse-Core]   teleportintercept: " + plugin.getMVConfig().getTeleportIntercept() + '\n'
                 + "[Multiverse-Core]   firstspawnoverride: " + plugin.getMVConfig().getFirstSpawnOverride() + '\n'
                 + "[Multiverse-Core]   displaypermerrors: " + plugin.getMVConfig().getDisplayPermErrors() + '\n'

src/main/java/com/onarandombox/MultiverseCore/listeners/AsyncChatEvent.java

@@ -0,0 +1,35 @@
+package com.onarandombox.MultiverseCore.listeners;
+
+import org.bukkit.entity.Player;
+import org.bukkit.event.player.AsyncPlayerChatEvent;
+
+/**
+ * A wrapper for the {@link AsyncPlayerChatEvent}.
+ */
+public class AsyncChatEvent implements ChatEvent {
+    private final AsyncPlayerChatEvent event;
+
+    public AsyncChatEvent(AsyncPlayerChatEvent event) {
+        this.event = event;
+    }
+
+    @Override
+    public boolean isCancelled() {
+        return event.isCancelled();
+    }
+
+    @Override
+    public String getFormat() {
+        return event.getFormat();
+    }
+
+    @Override
+    public void setFormat(String s) {
+        event.setFormat(s);
+    }
+
+    @Override
+    public Player getPlayer() {
+        return event.getPlayer();
+    }
+}

src/main/java/com/onarandombox/MultiverseCore/listeners/ChatEvent.java

@@ -0,0 +1,29 @@
+package com.onarandombox.MultiverseCore.listeners;
+
+import org.bukkit.entity.Player;
+
+/**
+ * A wrapper for the two chat-events in Bukkit.
+ */
+public interface ChatEvent {
+    /**
+     * @return Whether this event is cancelled.
+     */
+    boolean isCancelled();
+
+    /**
+     * @return The format.
+     */
+    String getFormat();
+
+    /**
+     * Sets the format.
+     * @param s The new format.
+     */
+    void setFormat(String s);
+
+    /**
+     * @return The player.
+     */
+    Player getPlayer();
+}

src/main/java/com/onarandombox/MultiverseCore/listeners/MVAsyncPlayerChatListener.java

@@ -0,0 +1,35 @@
+/******************************************************************************
+ * Multiverse 2 Copyright (c) the Multiverse Team 2011.                       *
+ * Multiverse 2 is licensed under the BSD License.                            *
+ * For more information please check the README.md file included              *
+ * with this project.                                                         *
+ ******************************************************************************/
+
+package com.onarandombox.MultiverseCore.listeners;
+
+import java.util.logging.Level;
+
+import com.dumptruckman.minecraft.util.Logging;
+import org.bukkit.event.EventHandler;
+import org.bukkit.event.player.AsyncPlayerChatEvent;
+
+import com.onarandombox.MultiverseCore.MultiverseCore;
+
+/**
+ * Multiverse's {@link org.bukkit.event.Listener} for players.
+ */
+public class MVAsyncPlayerChatListener extends MVChatListener {
+    public MVAsyncPlayerChatListener(MultiverseCore plugin, MVPlayerListener playerListener) {
+        super(plugin, playerListener);
+        Logging.fine("Created AsyncPlayerChatEvent listener.");
+    }
+
+    /**
+     * This method is called when a player wants to chat.
+     * @param event The Event that was fired.
+     */
+    @EventHandler
+    public void playerChat(AsyncPlayerChatEvent event) {
+        this.playerChat(new AsyncChatEvent(event));
+    }
+}

src/main/java/com/onarandombox/MultiverseCore/listeners/MVChatListener.java

@@ -5,14 +5,13 @@ import com.onarandombox.MultiverseCore.api.MVWorldManager;
 import com.onarandombox.MultiverseCore.api.MultiverseWorld;
 
 import org.bukkit.ChatColor;
-import org.bukkit.event.EventHandler;
+import org.bukkit.entity.Player;
 import org.bukkit.event.Listener;
-import org.bukkit.event.player.AsyncPlayerChatEvent;
 
 /**
  * Multiverse's {@link org.bukkit.event.Listener} for players.
  */
-public class MVChatListener implements Listener {
+public abstract class MVChatListener implements Listener {
     private final MultiverseCore plugin;
     private final MVWorldManager worldManager;
     private final MVPlayerListener playerListener;
@@ -24,39 +23,34 @@ public class MVChatListener implements Listener {
     }
 
     /**
-     * This method is called when an a player sends a chat message.
-     * @param event The Event that was fired.
+     * This handles a {@link ChatEvent}.
+     * @param event The {@link ChatEvent}.
      */
-    @EventHandler
-    public void playerChat(AsyncPlayerChatEvent event) {
-        if (event.isCancelled()) {
+    public void playerChat(ChatEvent event) {
+        if (event.isCancelled() || !plugin.getMVConfig().getPrefixChat()) {
             return;
         }
-        // Check whether the Server is set to prefix the chat with the World name.
-        // If not we do nothing, if so we need to check if the World has an Alias.
-        if (plugin.getMVConfig().getPrefixChat()) {
-            String world = playerListener.getPlayerWorld().get(event.getPlayer().getName());
-            if (world == null) {
-                world = event.getPlayer().getWorld().getName();
-                playerListener.getPlayerWorld().put(event.getPlayer().getName(), world);
-            }
-            String prefix = "";
-            // If we're not a MV world, don't do anything
-            if (!this.worldManager.isMVWorld(world)) {
-                return;
-            }
-            MultiverseWorld mvworld = this.worldManager.getMVWorld(world);
-            if (mvworld.isHidden()) {
-                return;
-            }
-            prefix = mvworld.getColoredWorldString();
-            String chat = event.getFormat();
-            
-            String prefixChatFormat = plugin.getMVConfig().getPrefixChatFormat();
-            prefixChatFormat = prefixChatFormat.replace("%world%", prefix).replace("%chat%", chat);
-            prefixChatFormat = ChatColor.translateAlternateColorCodes('&', prefixChatFormat);
-            
-            event.setFormat(prefixChatFormat);
+
+        MultiverseWorld mvworld = getPlayerWorld(event.getPlayer());
+        if (mvworld == null || mvworld.isHidden()) {
+            return;
         }
+
+        String prefixChatFormat = plugin.getMVConfig().getPrefixChatFormat()
+                .replace("%world%", mvworld.getColoredWorldString())
+                .replace("%chat%", event.getFormat());
+        
+        prefixChatFormat = ChatColor.translateAlternateColorCodes('&', prefixChatFormat);
+
+        event.setFormat(prefixChatFormat);
+    }
+
+    private MultiverseWorld getPlayerWorld(Player player) {
+        String world = playerListener.getPlayerWorld().get(player.getName());
+        if (world == null) {
+            world = player.getWorld().getName();
+            playerListener.getPlayerWorld().put(player.getName(), world);
+        }
+        return this.worldManager.getMVWorld(world);
     }
 }

src/main/java/com/onarandombox/MultiverseCore/listeners/MVPlayerChatListener.java

@@ -0,0 +1,36 @@
+/******************************************************************************
+ * Multiverse 2 Copyright (c) the Multiverse Team 2011.                       *
+ * Multiverse 2 is licensed under the BSD License.                            *
+ * For more information please check the README.md file included              *
+ * with this project.                                                         *
+ ******************************************************************************/
+
+package com.onarandombox.MultiverseCore.listeners;
+
+import java.util.logging.Level;
+
+import com.dumptruckman.minecraft.util.Logging;
+import org.bukkit.event.EventHandler;
+import org.bukkit.event.player.PlayerChatEvent;
+
+import com.onarandombox.MultiverseCore.MultiverseCore;
+
+/**
+ * Multiverse's {@link org.bukkit.event.Listener} for players.
+ */
+@SuppressWarnings("deprecation") // this exists only for downwards compatibility
+public class MVPlayerChatListener extends MVChatListener {
+    public MVPlayerChatListener(MultiverseCore plugin, MVPlayerListener playerListener) {
+        super(plugin, playerListener);
+        Logging.fine("Registered PlayerChatEvent listener.");
+    }
+
+    /**
+     * This method is called when a player wants to chat.
+     * @param event The Event that was fired.
+     */
+    @EventHandler
+    public void playerChat(PlayerChatEvent event) {
+        this.playerChat(new NormalChatEvent(event));
+    }
+}

src/main/java/com/onarandombox/MultiverseCore/listeners/NormalChatEvent.java

@@ -0,0 +1,37 @@
+package com.onarandombox.MultiverseCore.listeners;
+
+import org.bukkit.entity.Player;
+import org.bukkit.event.player.PlayerChatEvent;
+
+/**
+ * A wrapper for the {@link PlayerChatEvent}.
+ * @deprecated This is deprecated like the {@link PlayerChatEvent}.
+ */
+@Deprecated
+public class NormalChatEvent implements ChatEvent {
+    private final PlayerChatEvent event;
+
+    public NormalChatEvent(PlayerChatEvent event) {
+        this.event = event;
+    }
+
+    @Override
+    public boolean isCancelled() {
+        return event.isCancelled();
+    }
+
+    @Override
+    public String getFormat() {
+        return event.getFormat();
+    }
+
+    @Override
+    public void setFormat(String s) {
+        event.setFormat(s);
+    }
+
+    @Override
+    public Player getPlayer() {
+        return event.getPlayer();
+    }
+}

src/test/java/com/onarandombox/MultiverseCore/TestWorldProperties.java

@@ -10,7 +10,7 @@ package com.onarandombox.MultiverseCore;
 import com.onarandombox.MultiverseCore.api.MVWorldManager;
 import com.onarandombox.MultiverseCore.api.MultiverseWorld;
 import com.onarandombox.MultiverseCore.configuration.SpawnLocation;
-import com.onarandombox.MultiverseCore.listeners.MVChatListener;
+import com.onarandombox.MultiverseCore.listeners.MVAsyncPlayerChatListener;
 import com.onarandombox.MultiverseCore.utils.MockWorldFactory;
 import com.onarandombox.MultiverseCore.utils.TestInstanceCreator;
 import com.onarandombox.MultiverseCore.utils.WorldManager;
@@ -187,10 +187,10 @@ public class TestWorldProperties {
 
         // call player chat event
         core.getMVConfig().setPrefixChat(true);
-        core.getChatListener().playerChat(playerChatEvent);
+        ((MVAsyncPlayerChatListener) core.getChatListener()).playerChat(playerChatEvent);
         verify(playerChatEvent).setFormat("[" + mvWorld.getColoredWorldString() + "]" + "format");
         core.getMVConfig().setPrefixChat(false);
-        core.getChatListener().playerChat(playerChatEvent);
+        ((MVAsyncPlayerChatListener) core.getChatListener()).playerChat(playerChatEvent);
         verify(playerChatEvent, times(1)).setFormat(anyString()); // only ONE TIME (not the 2nd time!)
 
         // call player join events
@@ -281,15 +281,15 @@ public class TestWorldProperties {
 
         // call player chat event
         core.getMVConfig().setPrefixChat(true);
-        core.getChatListener().playerChat(playerChatEvent);
+        ((MVAsyncPlayerChatListener) core.getChatListener()).playerChat(playerChatEvent);
         // never because it's hidden!
         verify(playerChatEvent, never()).setFormat(
                 "[" + mvWorld.getColoredWorldString() + "]" + "format");
         mvWorld.setHidden(false);
-        core.getChatListener().playerChat(playerChatEvent);
+        ((MVAsyncPlayerChatListener) core.getChatListener()).playerChat(playerChatEvent);
         verify(playerChatEvent).setFormat("[" + mvWorld.getColoredWorldString() + "]" + "format");
         core.getMVConfig().setPrefixChat(false);
-        core.getChatListener().playerChat(playerChatEvent);
+        ((MVAsyncPlayerChatListener) core.getChatListener()).playerChat(playerChatEvent);
         verify(playerChatEvent, times(1)).setFormat(anyString()); // only ONE TIME (not the 2nd time!)
         mvWorld.setHidden(true); // reset hidden-state
 

src/test/java/com/onarandombox/MultiverseCore/utils/TestInstanceCreator.java

@@ -10,7 +10,6 @@ package com.onarandombox.MultiverseCore.utils;
 import buscript.Buscript;
 import com.onarandombox.MultiverseCore.MultiverseCore;
 import com.onarandombox.MultiverseCore.api.MultiverseWorld;
-import com.onarandombox.MultiverseCore.listeners.MVChatListener;
 import com.onarandombox.MultiverseCore.listeners.MVEntityListener;
 import com.onarandombox.MultiverseCore.listeners.MVPlayerListener;
 import com.onarandombox.MultiverseCore.listeners.MVWeatherListener;
@@ -245,12 +244,6 @@ public class TestInstanceCreator {
             weatherlistenerfield.setAccessible(true);
             weatherlistenerfield.set(core, wl);
 
-            // Set weatherListener
-            MVChatListener cl = PowerMockito.spy(new MVChatListener(core, pl));
-            Field chatlistenerfield = MultiverseCore.class.getDeclaredField("chatListener");
-            chatlistenerfield.setAccessible(true);
-            chatlistenerfield.set(core, cl);
-
             // Init our command sender
             final Logger commandSenderLogger = Logger.getLogger("CommandSender");
             commandSenderLogger.setParent(Util.logger);