Merge pull request #33 from yoadsn/modify_stores_use_uuid

Modify stores use uuid

Author: yoadsn

README.md

@@ -15,6 +15,7 @@ This is quite a stable version, any issues or feature requests are welcome!
 - Allows definition of player groups, and sending chat messages to these groups
 - Alloes listening to all chats taking place on the server
 - Logs chat messages to files and/or [LogEntries](logentries.com)
+- Configuration store files use the player UUID since version 1.3
 
 ##Installation
 - Drop the JAR in the plugins folder
@@ -84,24 +85,24 @@ So for example, a "French" configured player might still send some "English" tex
 
 ##Language Configuration
 Language settings per player are stored in the file **langStore.json** in the plugin's data folder.
-This file contains a single JSON object. The keys of this object are the player name and the values are the language.
-Configuration of the language is stored in the file when the plugin is disabled and read then the plugin is enabled.
+This file contains a single JSON object. The keys of this object are the player UUID and the values are the language.
+Configuration of the language is stored in the file when the plugin is disabled and read when the plugin is enabled.
 It is possible to edit the configuration with a normal text editor but please note:
 - The file must contain a single valid JSON object in the format described above.
 - A restart of the plugin is required to read configuration which was edited directly in the file.
 
 Example of a valid language configuration JSON object:
 ```JSON
 {
-  "playerName1": "arabic",
-  "playerName2": "hebrew"
+  "player1UUID": "arabic",
+  "player2UUID": "hebrew"
 }
 ```
 
 ##Groups Configuration
-A Player can belong to a group (or more then one).
+A Player can belong to zero or more groups.
 To define the groups create a file called **groupsStore.json** in the plugin's data folder.
-The file contains a single JSON object. The keys of this object are the group name and the values are the group member players.
+The file contains a single JSON object. The keys of this object are the group name and the values are the group member players' UUID's.
 Each value is a JSON Array with string values for each player in the group.
 
 - The file must contain a single valid JSON object in the format described above.
@@ -113,8 +114,8 @@ Example of a valid groups configuration JSON object:
 ```JSON
 {
 	"blueGroup" : [
-		"playerName1",
-		"playerName2"
+		"player1UUID",
+		"player2UUID"
 	]
 }
 ```
@@ -146,6 +147,9 @@ The config.yml file can configure the following for chat logging:
 
 ##Latest Changes
 
+Since 1.3:
+- Groups and Languages store files use UUID. Old configuration file are not compatible and needs to be recreated. (No migration tool is available)
+
 Since 1.2:
 - Added chat logging support using a file logger and/or logentries logger.
 - Added a configuration key for the whispering radius

pom.xml

@@ -4,7 +4,7 @@
 
 	<groupId>org.gamesforpeace</groupId>
 	<artifactId>TonguesPlugin</artifactId>
-	<version>1.2</version>
+	<version>1.3</version>
 	<packaging>jar</packaging>
 
 	<name>TonguesPlugin</name>
@@ -30,7 +30,7 @@
 		<dependency>
 			<groupId>org.bukkit</groupId>
 			<artifactId>bukkit</artifactId>
-			<version>1.7.2-R0.2</version>
+			<version>1.7.9-R0.2</version>
 		</dependency>
 		<dependency>
 			<groupId>com.memetix</groupId>

src/main/java/org/gamesforpeace/tongues/ChatDestinationResolver.java

@@ -1,12 +1,15 @@
 package org.gamesforpeace.tongues;
 
 import java.util.Set;
+import java.util.UUID;
 
 import org.bukkit.entity.Player;
 
 public interface ChatDestinationResolver {
 
-	Player getOnlinePlayer(String string);
+	Player getOnlinePlayer(UUID id);
+	
+	Player getOnlinePlayer(String name);
 
 	Set<Player> getAllOnlinePlayers();
 

src/main/java/org/gamesforpeace/tongues/ConcurrentPlayerLanguageStore.java

@@ -11,32 +11,32 @@
 public class ConcurrentPlayerLanguageStore implements PlayerLanguageStore {
 
 	private final HashSet<String> supportedLanguages; 
-	private final ConcurrentHashMap<String, String> languageStore;
+	private final ConcurrentHashMap<UUID, String> languageStore;
 	private final String defaultLanguage;
 
 	public ConcurrentPlayerLanguageStore(Set<String> supportedLnaguages, String defaultLanguage) {
 		this.supportedLanguages = new HashSet<String>(supportedLnaguages);
-		languageStore = new ConcurrentHashMap<String, String>();
+		languageStore = new ConcurrentHashMap<UUID, String>();
 		this.defaultLanguage = defaultLanguage;
 	}
 
-	public String getLanguageForPlayer(String playerName) {
+	public String getLanguageForPlayer(UUID playerId) {
 
-		String playerStoredLang = languageStore.get(playerName);
+		String playerStoredLang = languageStore.get(playerId);
 		if (playerStoredLang == null) {
 			playerStoredLang = defaultLanguage;
-			languageStore.put(playerName, defaultLanguage);
+			languageStore.put(playerId, defaultLanguage);
 		}
 
 		return playerStoredLang;
 	}
 
-	public void setLanguageForPlayer(String playerName, String language) {
-		languageStore.put(playerName, language);
+	public void setLanguageForPlayer(UUID playerId, String language) {
+		languageStore.put(playerId, language);
 	}
 
-	public void clearLanguageForPlayer(String playerName) {
-		languageStore.remove(playerName);
+	public void clearLanguageForPlayer(UUID playerId) {
+		languageStore.remove(playerId);
 	}
 
 	public Boolean isLanguageSupported(String language) {
@@ -47,12 +47,12 @@ public String getDefaultLanguage() {
 		return defaultLanguage;
 	}
 
-	public Map<String, String> getAllPlayerLanguages() {
+	public Map<UUID, String> getAllPlayerLanguages() {
 		return Collections.unmodifiableMap(languageStore);
 	}
 
-	public void setPlayerLanguages(Map<String, String> playerLanguagesToSet) {
-		for (Entry<String, String> languagePlayerSetting : playerLanguagesToSet.entrySet()) {
+	public void setPlayerLanguages(Map<UUID, String> playerLanguagesToSet) {
+		for (Entry<UUID, String> languagePlayerSetting : playerLanguagesToSet.entrySet()) {
 			setLanguageForPlayer(languagePlayerSetting.getKey(), languagePlayerSetting.getValue());
 		}
 	}

src/main/java/org/gamesforpeace/tongues/PlayerLanguageStore.java

@@ -5,23 +5,23 @@
 
 public interface PlayerLanguageStore {
 
-	String getLanguageForPlayer(String playerName);
+	String getLanguageForPlayer(UUID playerId);
 
 	/**
 	 * This method does not check to see if the language is supported or not.
 	 * It is the callers responsibility to consult "IsLanguageSupported" if required.
-	 * @param playerName
+	 * @param playerId
 	 * @param language - assumed to always be a lowercase langauge name
 	 * @return
 	 */
-	void setLanguageForPlayer(String playerName, String language);
+	void setLanguageForPlayer(UUID playerId, String language);
 
 	/**
 	 * This method clears the setup language of a player
-	 * @param playerName
+	 * @param playerId
 	 * @return
 	 */
-	void clearLanguageForPlayer(String playerName);
+	void clearLanguageForPlayer(UUID playerId);
 
 	/**
 	 * Checks if this store supports the language
@@ -40,11 +40,11 @@ public interface PlayerLanguageStore {
 	 * Gets all non-default player languages stored
 	 * @return All stored non-default player langauges
 	 */
-	Map<String, String> getAllPlayerLanguages();
+	Map<UUID, String> getAllPlayerLanguages();
 
 	/**
 	 * Would use the set of values to override or add to the existing configuration
 	 * @param playerLanguagesToSet - Assumed to contain valid languages
 	 */
-	void setPlayerLanguages(Map<String, String> playerLanguagesToSet);
+	void setPlayerLanguages(Map<UUID, String> playerLanguagesToSet);
 }

src/main/java/org/gamesforpeace/tongues/SetLangCommandExecutor.java

@@ -76,7 +76,7 @@ public boolean onCommand(CommandSender sender, Command command, String label, St
 			// We have a player to operate on
 			if (subjectOfCommand != null) {
 
-				String currLang = langStore.getLanguageForPlayer(subjectOfCommand.getName());
+				String currLang = langStore.getLanguageForPlayer(subjectOfCommand.getUniqueId());
 
 				if (changeToLang.equalsIgnoreCase(QUERY_SETUP_LANG)) {
 					if (currLang.equalsIgnoreCase(langStore.getDefaultLanguage())) {
@@ -93,7 +93,7 @@ public boolean onCommand(CommandSender sender, Command command, String label, St
 					responseMessage = String.format(MSG_LANG_IS_ALREADY_SETUP_FTM, changeToLang);
 
 				} else if (changeToLang.equalsIgnoreCase(CLEAR_SETUP_LANG)) {
-					langStore.clearLanguageForPlayer(subjectOfCommand.getName());
+					langStore.clearLanguageForPlayer(subjectOfCommand.getUniqueId());
 					responseMessage = MSG_CLEARED_SETUP_LANG;
 
 					success = true;
@@ -103,7 +103,7 @@ public boolean onCommand(CommandSender sender, Command command, String label, St
 						responseMessage = String.format(ERR_LANG_NOT_SUPPORTED_FMT, changeToLang);
 
 					} else {
-						langStore.setLanguageForPlayer(subjectOfCommand.getName(), changeToLang);
+						langStore.setLanguageForPlayer(subjectOfCommand.getUniqueId(), changeToLang);
 						responseMessage = String.format(MSG_PLAYER_LANG_CHANGED_FMT, subjectOfCommand.getName(),
 								changeToLang);
 

src/main/java/org/gamesforpeace/tongues/TonguesPlugin.java

@@ -5,6 +5,7 @@
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Set;
+import java.util.UUID;
 import java.util.concurrent.CopyOnWriteArraySet;
 
 import org.bukkit.Bukkit;
@@ -32,7 +33,7 @@ public final class TonguesPlugin extends JavaPlugin implements ChatMessenger, Tr
 	private ListenCommandExecutor listenCommandExecutor;
 	private PlayerLanguageStore langStore;
 	private ChatLogger chatLogger = null;
-	private HashMap<String, HashSet<String>> groupsStore;
+	private HashMap<String, HashSet<UUID>> groupsStore;
 
 	@Override
     public void onEnable(){
@@ -102,10 +103,10 @@ private void LoadPlayerLanguages() {
 		try {
 			PlayerLanguageStorePersister langStorePersister = new PlayerLanguageStorePersister(getDataFolder(), LANG_STORE_FILENAME, getLogger());
 			if (!langStorePersister.load(langStore)) {
-				getLogger().warning("Could not load player languages configuration file upon plugin enable.");
+				getLogger().warning("Could not load player languages configuration file upon plugin enable. Did you migrate to UUIDs? Skipping.");
 			}
 		} catch (IOException e) {
-			getLogger().warning("Unable to access player languages persistence store for loading. Skipping.");
+			getLogger().warning("Unable to access player languages persistence store for loading. Did you migrate to UUIDs? Skipping.");
 		}
 	}
 
@@ -117,8 +118,8 @@ private void LoadGroups() {
 		}
 
 		if (groupsStore == null) {
-			groupsStore = new HashMap<String, HashSet<String>>();
-			getLogger().warning("Unable to access player groups persistence store for loading. Skipping.");
+			groupsStore = new HashMap<String, HashSet<UUID>>();
+			getLogger().warning("Unable to access player groups persistence store for loading. Did you migrate to UUIDs? Skipping.");
 		}
 	}
 
@@ -142,7 +143,7 @@ public void sendTranslatedMessageAsync(String message, Player source, Player des
 		final Player sendFrom = source;
 		final Player sendTo = dest;
 		final String sendMessage = message;
-		final String destinationLanguage = langStore.getLanguageForPlayer(sendTo.getName());
+		final String destinationLanguage = langStore.getLanguageForPlayer(sendTo.getUniqueId());
 
 		new BukkitRunnable() {
 
@@ -209,23 +210,27 @@ public void run() {
 	public void postCommand(CommandSender sender, String commandLine) {
 		Bukkit.dispatchCommand(sender, commandLine);
 	}
-
+	
 	public Player getOnlinePlayer(String name) {
 		return getServer().getPlayer(name);
 	}
 
+	public Player getOnlinePlayer(UUID id) {
+		return getServer().getPlayer(id);
+	}
+
 	public Set<Player> getAllOnlinePlayers() {
 		return new CopyOnWriteArraySet<Player>(Arrays.asList(getServer().getOnlinePlayers()));
 	}
 
 	public Set<Player> getGroupPlayers(String groupName) {
 		if (groupsStore.containsKey(groupName)) {
 
-			HashSet<String> groupPlayerNames = groupsStore.get(groupName); 
+			HashSet<UUID> groupPlayerIds = groupsStore.get(groupName); 
 
-			Set<Player> groupPlayers = new HashSet<Player>(groupPlayerNames.size());
-			for (String name : groupPlayerNames) {
-				Player player = getOnlinePlayer(name);
+			Set<Player> groupPlayers = new HashSet<Player>(groupPlayerIds.size());
+			for (UUID id : groupPlayerIds) {
+				Player player = getOnlinePlayer(id);
 				if (player != null) {
 					groupPlayers.add(player);
 				}

src/main/java/org/gamesforpeace/tongues/persistence/PlayerGroupsPersister.java

@@ -11,11 +11,13 @@
 import java.lang.reflect.Type;
 import java.util.HashMap;
 import java.util.HashSet;
+import java.util.UUID;
 import java.util.logging.Logger;
 
 import org.apache.commons.lang.Validate;
 
 import com.google.common.base.Charsets;
+import com.google.common.io.Files;
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
 import com.google.gson.reflect.TypeToken;
@@ -49,7 +51,7 @@ private File getDataFile() {
 		return dataFile;
 	}
 
-	public boolean persist(HashMap<String, HashSet<String>> playerGroups) {
+	public boolean persist(HashMap<String, HashSet<UUID>> playerGroups) {
 		File outputDataFile = getDataFile();
 		if (outputDataFile != null) {
 
@@ -59,7 +61,7 @@ public boolean persist(HashMap<String, HashSet<String>> playerGroups) {
 				BufferedWriter writer = new BufferedWriter(osw);
 
 				try{
-					Type storedType = new TypeToken<HashMap<String, HashSet<String>>>() { }.getType();
+					Type storedType = new TypeToken<HashMap<String, HashSet<UUID>>>() { }.getType();
 					writer.write(gson.toJson(playerGroups, storedType));
 				} finally {
 					writer.close();
@@ -79,16 +81,16 @@ public boolean persist(HashMap<String, HashSet<String>> playerGroups) {
 		return false;
 	}
 
-	public HashMap<String, HashSet<String>> load() {
+	public HashMap<String, HashSet<UUID>> load() {
 		File inputDataFile = getDataFile();
 		if (inputDataFile != null) {
 
 			try {
 				InputStreamReader isr = new InputStreamReader( new FileInputStream(inputDataFile), Charsets.UTF_8);
 				JsonReader reader = new JsonReader(isr);
 
-				Type typeOfHashMap = new TypeToken<HashMap<String, HashSet<String>>>() { }.getType();
-				HashMap<String, HashSet<String>> playerGroups = gson.fromJson(reader, typeOfHashMap);
+				Type typeOfHashMap = new TypeToken<HashMap<String, HashSet<UUID>>>() { }.getType();
+				HashMap<String, HashSet<UUID>> playerGroups = gson.fromJson(reader, typeOfHashMap);
 
 				reader.close();
 
@@ -102,6 +104,16 @@ public HashMap<String, HashSet<String>> load() {
 			}
 		}
 
+		if (inputDataFile.exists()) {
+			logger.info("Possible format error. Copying old groups store file aside before it is overridden with a new empty store file in the correct format.");
+			File badFormatFile = new File(datafolder, "bad_format_" + storageFileName);
+			try {
+				Files.copy(inputDataFile, badFormatFile);
+			} catch (IOException e) {
+				logger.warning(e.toString());
+			}
+		}
+		
 		return null;
 	}
 }