Meishin/LoginSystem
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

#482 Provide better default messages and merge MessagesManager

Browse Source 
- Return message from the JAR's messages_en.yml file instead of an unusable error for the end user
- Merge MessagesManager into Messages
This commit is contained in:
ljacqu
2016-02-11 21:27:16 +01:00
parent 2d8a80049b
commit 39168bc818
12 changed files with 271 additions and 135 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/main/java/fr/xephi/authme/AuthMe.java
+1 -1
View File
@@ -231,7 +231,7 @@ public class AuthMe extends JavaPlugin {
return;
}
messages = new Messages(newSettings.getMessagesFile());
messages = new Messages(newSettings.getMessagesFile(), newSettings.getDefaultMessagesFile());
// Connect to the database and setup tables
try {
src/main/java/fr/xephi/authme/output/Messages.java
+61 -15
View File
@@ -1,7 +1,11 @@
package fr.xephi.authme.output;
import fr.xephi.authme.ConsoleLogger;
import fr.xephi.authme.util.StringUtils;
import org.bukkit.ChatColor;
import org.bukkit.command.CommandSender;
import org.bukkit.configuration.file.FileConfiguration;
import org.bukkit.configuration.file.YamlConfiguration;
import java.io.File;
@@ -12,15 +16,19 @@ import java.io.File;
*/
public class Messages {
private MessagesManager manager;
private FileConfiguration configuration;
private String fileName;
private File defaultFile;
private FileConfiguration defaultConfiguration;
/**
* Constructor.
*
* @param messageFile The messages file to use
*/
public Messages(File messageFile) {
manager = new MessagesManager(messageFile);
public Messages(File messageFile, File defaultFile) {
initializeFile(messageFile);
this.defaultFile = defaultFile;
}
/**
@@ -30,7 +38,7 @@ public class Messages {
* @param key The key of the message to send
*/
public void send(CommandSender sender, MessageKey key) {
String[] lines = manager.retrieve(key.getKey());
String[] lines = retrieve(key);
for (String line : lines) {
sender.sendMessage(line);
}
@@ -38,7 +46,7 @@ public class Messages {
/**
* Send the given message code to the player with the given tag replacements. Note that this method
* issues an exception if the number of supplied replacements doesn't correspond to the number of tags
* logs an error if the number of supplied replacements doesn't correspond to the number of tags
* the message key contains.
*
* @param sender The entity to send the message to
@@ -48,13 +56,13 @@ public class Messages {
public void send(CommandSender sender, MessageKey key, String... replacements) {
String message = retrieveSingle(key);
String[] tags = key.getTags();
if (replacements.length != tags.length) {
throw new IllegalStateException(
"Given replacement size does not match the tags in message key '" + key + "'");
}
for (int i = 0; i < tags.length; ++i) {
message = message.replace(tags[i], replacements[i]);
if (replacements.length == tags.length) {
for (int i = 0; i < tags.length; ++i) {
message = message.replace(tags[i], replacements[i]);
}
} else {
ConsoleLogger.showError("Invalid number of replacements for message key '" + key + "'");
send(sender, key);
}
for (String line : message.split("\n")) {
@@ -66,11 +74,18 @@ public class Messages {
* Retrieve the message from the text file and return it split by new line as an array.
*
* @param key The message key to retrieve
*
* @return The message split by new lines
*/
public String[] retrieve(MessageKey key) {
return manager.retrieve(key.getKey());
final String code = key.getKey();
String message = configuration.getString(code);
if (message == null) {
ConsoleLogger.showError("Error getting message with key '" + code + "'. "
+ "Please verify your config file at '" + fileName + "'");
return formatMessage(getDefault(code));
}
return formatMessage(message);
}
/**
@@ -88,7 +103,38 @@ public class Messages {
* Reload the messages manager.
*/
public void reload(File messagesFile) {
manager = new MessagesManager(messagesFile);
initializeFile(messagesFile);
}
private void initializeFile(File messageFile) {
this.configuration = YamlConfiguration.loadConfiguration(messageFile);
this.fileName = messageFile.getName();
}
private String getDefault(String code) {
if (defaultFile == null) {
return getDefaultErrorMessage(code);
}
if (defaultConfiguration == null) {
defaultConfiguration = YamlConfiguration.loadConfiguration(defaultFile);
}
String message = defaultConfiguration.getString(code);
return (message == null)
? "Error retrieving message '" + code + "'"
: message;
}
private static String getDefaultErrorMessage(String code) {
return "Error retrieving message '" + code + "'";
}
private static String[] formatMessage(String message) {
String[] lines = message.split("&n");
for (int i = 0; i < lines.length; ++i) {
lines[i] = ChatColor.translateAlternateColorCodes('&', lines[i]);
}
return lines;
}
}
src/main/java/fr/xephi/authme/output/MessagesManager.java
-58
View File
@@ -1,58 +0,0 @@
package fr.xephi.authme.output;
import fr.xephi.authme.ConsoleLogger;
import org.bukkit.ChatColor;
import org.bukkit.configuration.file.YamlConfiguration;
import java.io.File;
/**
* Class responsible for reading messages from a file and formatting them for Minecraft.
* <p>
* This class is used within {@link Messages}, which offers a high-level interface for accessing
* or sending messages from a properties file.
*/
class MessagesManager {
private final YamlConfiguration configuration;
private final String fileName;
/**
* Constructor for Messages.
*
* @param file the configuration file
*/
MessagesManager(File file) {
this.fileName = file.getName();
this.configuration = YamlConfiguration.loadConfiguration(file);
}
/**
* Retrieve the message from the configuration file.
*
* @param key The key to retrieve
*
* @return The message
*/
public String[] retrieve(String key) {
String message = configuration.getString(key);
if (message != null) {
return formatMessage(message);
}
// Message is null: log key not being found and send error back as message
String retrievalError = "Error getting message with key '" + key + "'. ";
ConsoleLogger.showError(retrievalError + "Please verify your config file at '" + fileName + "'");
return new String[]{
retrievalError + "Please contact the admin to verify or update the AuthMe messages file."};
}
private static String[] formatMessage(String message) {
String[] lines = message.split("&n");
for (int i = 0; i < lines.length; ++i) {
lines[i] = ChatColor.translateAlternateColorCodes('&', lines[i]);
}
return lines;
}
}
src/main/java/fr/xephi/authme/settings/NewSetting.java
+16
View File
@@ -18,6 +18,7 @@ import org.yaml.snakeyaml.Yaml;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.net.URL;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.Arrays;
@@ -108,6 +109,21 @@ public class NewSetting {
return messagesFile;
}
/**
* Return the default messages file within the JAR that should contain all messages.
*
* @return The default messages file, or {@code null} if it could not be retrieved
*/
public File getDefaultMessagesFile() {
String defaultFilePath = "/messages/messages_en.yml";
URL url = NewSetting.class.getResource(defaultFilePath);
if (url == null) {
return null;
}
File file = new File(url.getFile());
return file.exists() ? file : null;
}
public String getEmailMessage() {
return emailMessage;
}