First sweep over Essentials Chat, to implement 2.8 changes.

Formatting cache still needs reimplemented.

Essentials/src/com/earth2me/essentials/api/IGroups.java

@@ -2,6 +2,7 @@ package com.earth2me.essentials.api;
 
 import com.earth2me.essentials.settings.Groups;
 import com.earth2me.essentials.storage.IStorageObjectHolder;
+import java.text.MessageFormat;
 
 
 public interface IGroups extends IStorageObjectHolder<Groups>
@@ -18,5 +19,5 @@ public interface IGroups extends IStorageObjectHolder<Groups>
 
 	int getHomeLimit(IUser player);
 
-	String getChatFormat(IUser player);
+	MessageFormat getChatFormat(IUser player);
 }

Essentials/src/com/earth2me/essentials/settings/GroupsHolder.java

@@ -7,10 +7,8 @@ import com.earth2me.essentials.api.ISettings;
 import com.earth2me.essentials.api.IUser;
 import com.earth2me.essentials.storage.AsyncStorageObjectHolder;
 import java.io.File;
-import java.util.ArrayList;
+import java.text.MessageFormat;
-import java.util.Collection;
+import java.util.*;
-import java.util.Collections;
-import java.util.Map;
 import java.util.Map.Entry;
 import lombok.Cleanup;
 
@@ -150,8 +148,23 @@ public class GroupsHolder extends AsyncStorageObjectHolder<Groups> implements IG
 		return 0;
 	}
 	
+	//TODO: Reimplement caching
 	@Override
-	public String getChatFormat(final IUser player)
+	public MessageFormat getChatFormat(final IUser player)
+	{
+			String format = getRawChatFormat(player);
+			format = Util.replaceColor(format);
+			format = format.replace("{DISPLAYNAME}", "%1$s");
+			format = format.replace("{GROUP}", "{0}");
+			format = format.replace("{MESSAGE}", "%2$s");
+			format = format.replace("{WORLDNAME}", "{1}");
+			format = format.replace("{SHORTWORLDNAME}", "{2}");
+			format = format.replaceAll("\\{(\\D*)\\}", "\\[$1\\]");
+			MessageFormat mFormat = new MessageFormat(format);
+			return mFormat;		
+	}
+	
+	private String getRawChatFormat(final IUser player)
 	{
 		for (GroupOptions groupOptions : getGroups(player))
 		{
@@ -165,4 +178,5 @@ public class GroupsHolder extends AsyncStorageObjectHolder<Groups> implements IG
 		settings.acquireReadLock();
 		return settings.getData().getChat().getDefaultFormat();
 	}
+	
 }

EssentialsChat/src/com/earth2me/essentials/chat/ChatStore.java

@@ -12,7 +12,7 @@ public class ChatStore
 	private final transient Trade charge;
 	private long radius;
 
-	ChatStore(final IEssentials ess, final IUser user, final String type)
+	public ChatStore(final IEssentials ess, final IUser user, final String type)
 	{
 		this.user = user;
 		this.type = type;

EssentialsChat/src/com/earth2me/essentials/chat/EssentialsChat.java

@@ -9,8 +9,6 @@ import java.util.HashMap;
 import java.util.Map;
 import java.util.logging.Level;
 import java.util.logging.Logger;
-import org.bukkit.event.Event.Priority;
-import org.bukkit.event.Event.Type;
 import org.bukkit.event.player.PlayerChatEvent;
 import org.bukkit.plugin.PluginManager;
 import org.bukkit.plugin.java.JavaPlugin;
@@ -35,17 +33,18 @@ public class EssentialsChat extends JavaPlugin
 			return;
 		}
 
-		final Map<PlayerChatEvent, String> charges = new HashMap<PlayerChatEvent, String>();
+		final Map<PlayerChatEvent, ChatStore> chatStore = new HashMap<PlayerChatEvent, ChatStore>();
 
 
-		final EssentialsChatPlayerListenerLowest playerListenerLowest = new EssentialsChatPlayerListenerLowest(getServer(), ess);
+		final EssentialsChatPlayerListenerLowest playerListenerLowest = new EssentialsChatPlayerListenerLowest(getServer(), ess, chatStore);
-		final EssentialsChatPlayerListenerNormal playerListenerNormal = new EssentialsChatPlayerListenerNormal(getServer(), ess, charges);
+		final EssentialsChatPlayerListenerNormal playerListenerNormal = new EssentialsChatPlayerListenerNormal(getServer(), ess, chatStore);
-		final EssentialsChatPlayerListenerHighest playerListenerHighest = new EssentialsChatPlayerListenerHighest(getServer(), ess, charges);
+		final EssentialsChatPlayerListenerHighest playerListenerHighest = new EssentialsChatPlayerListenerHighest(getServer(), ess, chatStore);
+		pluginManager.registerEvents(playerListenerLowest, this);
+		pluginManager.registerEvents(playerListenerNormal, this);
+		pluginManager.registerEvents(playerListenerHighest, this);
+		
 		final EssentialsLocalChatEventListener localChatListener = new EssentialsLocalChatEventListener(getServer(), ess);
-		pluginManager.registerEvent(Type.PLAYER_CHAT, playerListenerLowest, Priority.Lowest, this);
+		pluginManager.registerEvents(localChatListener, this);
-		pluginManager.registerEvent(Type.PLAYER_CHAT, playerListenerNormal, Priority.Normal, this);
-		pluginManager.registerEvent(Type.PLAYER_CHAT, playerListenerHighest, Priority.Highest, this);
-		pluginManager.registerEvent(Type.CUSTOM_EVENT, localChatListener, Priority.Highest, this);
 
 		LOGGER.info(_("loadinfo", this.getDescription().getName(), this.getDescription().getVersion(), "essentials team"));
 	}

EssentialsChat/src/com/earth2me/essentials/chat/EssentialsChatPlayer.java

@@ -3,7 +3,9 @@ package com.earth2me.essentials.chat;
 import com.earth2me.essentials.ChargeException;
 import static com.earth2me.essentials.I18n._;
 import com.earth2me.essentials.Trade;
+import com.earth2me.essentials.Util;
 import com.earth2me.essentials.api.IEssentials;
+import com.earth2me.essentials.api.IGroups;
 import com.earth2me.essentials.api.ISettings;
 import com.earth2me.essentials.api.IUser;
 import java.util.Locale;
@@ -12,119 +14,98 @@ import java.util.logging.Logger;
 import org.bukkit.Server;
 import org.bukkit.command.CommandSender;
 import org.bukkit.entity.Player;
+import org.bukkit.event.Listener;
 import org.bukkit.event.player.PlayerChatEvent;
-import org.bukkit.event.player.PlayerListener;
 
 //TODO: Translate the local/spy tags
-public abstract class EssentialsChatPlayer extends PlayerListener
+public abstract class EssentialsChatPlayer implements Listener
 {
 	protected transient IEssentials ess;
-	protected final static Logger logger = Logger.getLogger("Minecraft");
+	protected final static Logger LOGGER = Logger.getLogger("Minecraft");
 	protected final transient Server server;
+	protected final transient Map<PlayerChatEvent, ChatStore> chatStorage;
 
-	public EssentialsChatPlayer(final Server server, final IEssentials ess)
+	public EssentialsChatPlayer(final Server server,
+								final IEssentials ess,
+								final Map<PlayerChatEvent, ChatStore> chatStorage)
 	{
 		this.ess = ess;
 		this.server = server;
+		this.chatStorage = chatStorage;
 	}
 
-	@Override
 	public void onPlayerChat(final PlayerChatEvent event)
 	{
 	}
 
-	public boolean isAborted(final PlayerChatEvent event)
+	public ChatStore getChatStore(final PlayerChatEvent event)
 	{
-		return isAborted(event, "chat");
+		return chatStorage.get(event);
 	}
 
-	public boolean isAborted(final PlayerChatEvent event, final String command)
+	public void setChatStore(final PlayerChatEvent event, final ChatStore chatStore)
 	{
-		if (event.isCancelled())
+		chatStorage.put(event, chatStore);
-		{
-			return true;
 	}
 
-		final IUser user = ess.getUser(event.getPlayer());
+	public ChatStore delChatStore(final PlayerChatEvent event)
-		if (!isAffordableFor(user, command))
 	{
-			event.setCancelled(true);
+		return chatStorage.remove(event);
-			return true;
-		}
-		return false;
 	}
 
-	protected void chargeChat (final PlayerChatEvent event, final Map<PlayerChatEvent, String> charges) {
+	protected void chargeChat(final PlayerChatEvent event, final ChatStore chatStore)
-		
-		final IUser user = ess.getUser(event.getPlayer());
-		
-		String charge = charges.remove(event);
-		if (charge == null)
 	{
-			charge = "chat";
-		}		
-
 		try
 		{
-			charge(user, charge);
+			charge(chatStore.getUser(), chatStore.getCharge());
 		}
 		catch (ChargeException e)
 		{
-			ess.getCommandHandler().showCommandError(user, charge, e);
+			ess.getCommandHandler().showCommandError(chatStore.getUser(), chatStore.getLongType(), e);
 			event.setCancelled(true);
 		}
 	}
 
-	protected void charge(final CommandSender sender, final String command) throws ChargeException
+	protected void charge(final CommandSender sender, final Trade charge) throws ChargeException
 	{
 		if (sender instanceof Player)
 		{
-			final Trade charge = new Trade(command, ess);
 			charge.charge(ess.getUser((Player)sender));
 		}
 	}
 
-	protected boolean isAffordableFor(final CommandSender sender, final String command)
+	protected void formatChat(final PlayerChatEvent event, final ChatStore chatStore)
 	{
-		if (sender instanceof Player)
+		final IUser user = chatStore.getUser();
-		{
-			try
-			{
-				final Trade charge = new Trade(command, ess);
-				charge.isAffordableFor(ess.getUser((Player)sender));
-			}
-			catch (ChargeException e)
-			{
-				return false;
-			}
-		}
-		else
-		{
-			return false;
-		}
-
-		return true;
-	}
-
-	protected void formatChat(final PlayerChatEvent event)
-	{
-		final IUser user = ess.getUser(event.getPlayer());
 		if (user.isAuthorized("essentials.chat.color"))
 		{
-			event.setMessage(event.getMessage().replaceAll("&([0-9a-f])", "\u00a7$1"));
+			event.setMessage(Util.stripColor(event.getMessage()));
 		}
-		String format = ess.getGroups().getChatFormat(user);
+		String group = user.getGroup();
-		event.setFormat(format.replace('&', '\u00a7').replace("\u00a7\u00a7", "&").replace("{DISPLAYNAME}", "%1$s").replace("{GROUP}", user.getGroup()).replace("{MESSAGE}", "%2$s").replace("{WORLDNAME}", user.getWorld().getName()).replace("{SHORTWORLDNAME}", user.getWorld().getName().substring(0, 1).toUpperCase(Locale.ENGLISH)));
+		String world = user.getWorld().getName();
+		
+		IGroups groupSettings = ess.getGroups();
+		groupSettings.acquireReadLock();
+		try
+		{			
+			event.setFormat(groupSettings.getChatFormat(user).format(new Object[] {group, world, world.substring(0, 1).toUpperCase(Locale.ENGLISH)}));
+		}
+		finally
+		{
+			groupSettings.unlock();
 		}
 		
+	}
+
+	//TODO: Flesh this out - '?' trigger is too easily accidentally triggered
 	protected String getChatType(final String message)
 	{
 		switch (message.charAt(0))
 		{
 		case '!':
 			return "shout";
-		case '?':
+		//case '?':
-			return "question";
+			//return "question";
 		//case '@':
 		//	return "admin";			
 		default:
@@ -132,50 +113,48 @@ public abstract class EssentialsChatPlayer extends PlayerListener
 		}
 	}
 
-	protected void handleLocalChat(final Map<PlayerChatEvent, String> charges, final PlayerChatEvent event)
+	protected void handleLocalChat(final PlayerChatEvent event, final ChatStore chatStore)
 	{
 		long radius = 0;
 		ISettings settings = ess.getSettings();
 		settings.acquireReadLock();
-		try {
+		try
+		{
 			radius = settings.getData().getChat().getLocalRadius();
-		} finally {
+		}
+		finally
+		{
 			settings.unlock();
 		}
 		radius *= radius;
+		chatStore.setRadius(radius);
 
-		final IUser user = ess.getUser(event.getPlayer());
+		final IUser user = chatStore.getUser();
-		final String chatType = getChatType(event.getMessage());
-		final StringBuilder command = new StringBuilder();
-		command.append("chat");		
 
-		if (event.getMessage().length() > 0 && chatType.length() > 0)
+		if (event.getMessage().length() > 1 && chatStore.getType().length() > 0)
 		{
-			command.append("-").append(chatType);
 			final StringBuilder permission = new StringBuilder();
-			permission.append("essentials.chat.").append(chatType);
+			permission.append("essentials.chat.").append(chatStore.getType());
-
-			final StringBuilder format = new StringBuilder();
-			format.append(chatType).append("Format");
-
-			final StringBuilder errorMsg = new StringBuilder();
-			errorMsg.append("notAllowedTo").append(chatType.substring(0, 1).toUpperCase(Locale.ENGLISH)).append(chatType.substring(1));
 
 			if (user.isAuthorized(permission.toString()))
 			{
+				final StringBuilder format = new StringBuilder();
+				format.append(chatStore.getType()).append("Format");
 				event.setMessage(event.getMessage().substring(1));
 				event.setFormat(_(format.toString(), event.getFormat()));
-				charges.put(event, command.toString());
 				return;
 			}
 
+			final StringBuilder errorMsg = new StringBuilder();
+			errorMsg.append("notAllowedTo").append(chatStore.getType().substring(0, 1).toUpperCase(Locale.ENGLISH)).append(chatStore.getType().substring(1));
+
 			user.sendMessage(_(errorMsg.toString()));
 			event.setCancelled(true);
 			return;
 		}
 
 		event.setCancelled(true);
-		final EssentialsLocalChatEvent localChat = new EssentialsLocalChatEvent(event, radius);
+		final EssentialsLocalChatEvent localChat = new EssentialsLocalChatEvent(event, chatStore);
 		ess.getServer().getPluginManager().callEvent(localChat);
 	}
 }

EssentialsChat/src/com/earth2me/essentials/chat/EssentialsLocalChatEvent.java

@@ -3,6 +3,7 @@ package com.earth2me.essentials.chat;
 import org.bukkit.entity.Player;
 import org.bukkit.event.Cancellable;
 import org.bukkit.event.Event;
+import org.bukkit.event.HandlerList;
 import org.bukkit.event.player.PlayerChatEvent;
 
 
@@ -14,6 +15,7 @@ public class EssentialsLocalChatEvent extends Event implements Cancellable
 	private long radius;
 	private boolean cancelled = false;
 	private PlayerChatEvent parentEvent = null;
+	private static final HandlerList handlers = new HandlerList();
 
 	public EssentialsLocalChatEvent(final Player player, final String message, final String format, final long radius)
 	{
@@ -24,9 +26,9 @@ public class EssentialsLocalChatEvent extends Event implements Cancellable
 		this.radius = radius;
 	}
 
-	public EssentialsLocalChatEvent(final PlayerChatEvent event, final long radius)
+	public EssentialsLocalChatEvent(final PlayerChatEvent event, final ChatStore chatStore)
 	{
-		this(event.getPlayer(), event.getMessage(), event.getFormat(), radius);
+		this(event.getPlayer(), event.getMessage(), event.getFormat(), chatStore.getRadius());
 		this.parentEvent = event;
 	}
 
@@ -97,4 +99,14 @@ public class EssentialsLocalChatEvent extends Event implements Cancellable
 	{
 		return parentEvent;
 	}
+
+	public HandlerList getHandlers()
+	{
+		return handlers;
+	}
+
+	public static HandlerList getHandlerList()
+	{
+		return handlers;
+	}
 }

EssentialsChat/src/com/earth2me/essentials/chat/EssentialsLocalChatEventListener.java

@@ -1,16 +1,17 @@
 package com.earth2me.essentials.chat;
 
+import static com.earth2me.essentials.I18n._;
 import com.earth2me.essentials.api.IEssentials;
 import com.earth2me.essentials.api.IUser;
 import org.bukkit.Location;
 import org.bukkit.Server;
 import org.bukkit.World;
 import org.bukkit.entity.Player;
-import org.bukkit.event.CustomEventListener;
 import org.bukkit.event.Event;
+import org.bukkit.event.EventHandler;
 import org.bukkit.event.Listener;
  
-public class EssentialsLocalChatEventListener extends CustomEventListener implements Listener {
+public class EssentialsLocalChatEventListener implements Listener {
 
 	
 	protected transient IEssentials ess;
@@ -22,6 +23,7 @@ public class EssentialsLocalChatEventListener extends CustomEventListener implem
 		this.server = server;
 	}
 	
+	@EventHandler
     public void onLocalChat(final EssentialsLocalChatEvent event) {		
 		final Player sender = event.getPlayer();
 		if (event.getRadius() < 1)
@@ -34,7 +36,7 @@ public class EssentialsLocalChatEventListener extends CustomEventListener implem
 
 		for (Player onlinePlayer : server.getOnlinePlayers())
 		{
-			String type = "[L]";
+			String type = _("chatTypeLocal");
 			final IUser user = ess.getUser(onlinePlayer);
 			//TODO: remove reference to op 
 			if (user.isIgnoringPlayer(sender.getName()) && !sender.isOp())
@@ -54,7 +56,7 @@ public class EssentialsLocalChatEventListener extends CustomEventListener implem
 				{
 					if (user.isAuthorized("essentials.chat.spy"))
 					{
-						type = type.concat("[Spy]");
+						type = type.concat(_("chatTypeSpy"));
 					}
 					else
 					{
@@ -67,11 +69,4 @@ public class EssentialsLocalChatEventListener extends CustomEventListener implem
 			user.sendMessage(message);
 		}	
     } 
- 
-    @Override
-    public void onCustomEvent(final Event event) {
-        if (event instanceof EssentialsLocalChatEvent) {
-            onLocalChat((EssentialsLocalChatEvent) event);
-        }
-    }
 }

EssentialsChat/src/com/earth2me/essentials/chat/listenerlevel/EssentialsChatPlayerListenerHighest.java

@@ -1,32 +1,34 @@
 package com.earth2me.essentials.chat.listenerlevel;
 
 import com.earth2me.essentials.api.IEssentials;
+import com.earth2me.essentials.chat.ChatStore;
 import com.earth2me.essentials.chat.EssentialsChatPlayer;
 import java.util.Map;
 import org.bukkit.Server;
+import org.bukkit.event.EventHandler;
+import org.bukkit.event.EventPriority;
 import org.bukkit.event.player.PlayerChatEvent;
 
 
 public class EssentialsChatPlayerListenerHighest extends EssentialsChatPlayer
 {
-	private final transient Map<PlayerChatEvent, String> charges;
-
 	public EssentialsChatPlayerListenerHighest(final Server server,
 											   final IEssentials ess,
-											   final Map<PlayerChatEvent, String> charges)
+											   final Map<PlayerChatEvent, ChatStore> chatStorage)
 	{
-		super(server, ess);
+		super(server, ess, chatStorage);
-		this.charges = charges;
 	}
 
+	@EventHandler(priority = EventPriority.HIGHEST)
 	@Override
 	public void onPlayerChat(final PlayerChatEvent event)
 	{
-		if (isAborted(event))
+		final ChatStore chatStore = delChatStore(event);
+		if (event.isCancelled())
 		{
 			return;
 		}
 
-		chargeChat(event, charges);
+		chargeChat(event, chatStore);
 	}
 }

EssentialsChat/src/com/earth2me/essentials/chat/listenerlevel/EssentialsChatPlayerListenerLowest.java

@@ -1,26 +1,38 @@
 package com.earth2me.essentials.chat.listenerlevel;
 
 import com.earth2me.essentials.api.IEssentials;
+import com.earth2me.essentials.api.IUser;
+import com.earth2me.essentials.chat.ChatStore;
 import com.earth2me.essentials.chat.EssentialsChatPlayer;
+import java.util.Map;
 import org.bukkit.Server;
+import org.bukkit.event.EventHandler;
+import org.bukkit.event.EventPriority;
 import org.bukkit.event.player.PlayerChatEvent;
 
 
 public class EssentialsChatPlayerListenerLowest extends EssentialsChatPlayer
 {
-	public EssentialsChatPlayerListenerLowest(final Server server, final IEssentials ess)
+	public EssentialsChatPlayerListenerLowest(final Server server,
+											  final IEssentials ess,
+											  final Map<PlayerChatEvent, ChatStore> chatStorage)
 	{
-		super(server, ess);
+		super(server, ess, chatStorage);
 	}
 
+	@EventHandler(priority = EventPriority.LOWEST)
 	@Override
 	public void onPlayerChat(final PlayerChatEvent event)
 	{
-		if (isAborted(event))
+		if (event.isCancelled())
 		{
 			return;
 		}
 
-		formatChat(event);
+		final IUser user = ess.getUser(event.getPlayer());
+		final ChatStore chatStore = new ChatStore(ess, user, getChatType(event.getMessage()));
+		setChatStore(event, chatStore);
+
+		formatChat(event, chatStore);
 	}
 }

EssentialsChat/src/com/earth2me/essentials/chat/listenerlevel/EssentialsChatPlayerListenerNormal.java

@@ -1,32 +1,33 @@
 package com.earth2me.essentials.chat.listenerlevel;
 
 import com.earth2me.essentials.api.IEssentials;
+import com.earth2me.essentials.chat.ChatStore;
 import com.earth2me.essentials.chat.EssentialsChatPlayer;
 import java.util.Map;
 import org.bukkit.Server;
+import org.bukkit.event.EventHandler;
+import org.bukkit.event.EventPriority;
 import org.bukkit.event.player.PlayerChatEvent;
 
 
 public class EssentialsChatPlayerListenerNormal extends EssentialsChatPlayer
 {
-	private final transient Map<PlayerChatEvent, String> charges;
-
 	public EssentialsChatPlayerListenerNormal(final Server server,
 											  final IEssentials ess,
-											  final Map<PlayerChatEvent, String> charges)
+											  final Map<PlayerChatEvent, ChatStore> chatStorage)
 	{
-		super(server, ess);
+		super(server, ess, chatStorage);
-		this.charges = charges;
 	}
 
+	@EventHandler(priority = EventPriority.NORMAL)
 	@Override
 	public void onPlayerChat(final PlayerChatEvent event)
 	{
-		if (isAborted(event))
+		if (event.isCancelled())
 		{
 			return;
 		}
-
+		final ChatStore chatStore = getChatStore(event);
-		 handleLocalChat(charges, event);
+		handleLocalChat(event, chatStore);
 	}
 }