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

#293 Create class for handling messages from file with fallback

Browse Source 
- Move logic for loading a messages file with a default fallback into one class
- Remove message-specific handling from Settings class
This commit is contained in:
ljacqu
2016-10-07 22:28:08 +02:00
parent d78b7cc4af
commit 26716b0f79
11 changed files with 385 additions and 312 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/main/java/fr/xephi/authme/command/help/HelpMessageKey.java
+19 -19
View File
@@ -6,44 +6,44 @@ package fr.xephi.authme.command.help;
*/
public enum HelpMessageKey {
SHORT_DESCRIPTION("description.short", "Short description"),
SHORT_DESCRIPTION("description.short"),
DETAILED_DESCRIPTION("description.detailed", "Detailed description"),
DETAILED_DESCRIPTION("description.detailed"),
USAGE("usage", "Usage"),
USAGE("usage"),
ARGUMENTS("arguments", "Arguments"),
ARGUMENTS("arguments"),
OPTIONAL("optional", "(Optional)"),
OPTIONAL("optional"),
HAS_PERMISSION("hasPermission", "You have permission"),
HAS_PERMISSION("hasPermission"),
NO_PERMISSION("noPermission", "No permission"),
NO_PERMISSION("noPermission"),
ALTERNATIVES("alternatives", "Alternatives"),
ALTERNATIVES("alternatives"),
DEFAULT("default", "Default"),
DEFAULT("default"),
RESULT("result", "Result"),
RESULT("result"),
PERMISSIONS("permissions", "Permissions"),
PERMISSIONS("permissions"),
COMMANDS("commands", "Commands");
COMMANDS("commands");
private final String key;
private final String fallback;
HelpMessageKey(String key, String fallback) {
/**
* Constructor.
*
* @param key the message key
*/
HelpMessageKey(String key) {
this.key = "common." + key;
this.fallback = fallback;
}
/** @return the message key */
public String getKey() {
return key;
}
public String getFallback() {
return fallback;
}
}
src/main/java/fr/xephi/authme/command/help/HelpMessagesService.java
+12 -44
View File
@@ -5,16 +5,11 @@ import fr.xephi.authme.command.CommandArgumentDescription;
import fr.xephi.authme.command.CommandDescription;
import fr.xephi.authme.command.CommandUtils;
import fr.xephi.authme.initialization.Reloadable;
import fr.xephi.authme.message.MessageFileCopier;
import fr.xephi.authme.message.MessageFileCopier.MessageFileData;
import fr.xephi.authme.message.Messages;
import fr.xephi.authme.message.MessageFileHandlerProvider;
import fr.xephi.authme.message.MessageFileHandler;
import fr.xephi.authme.permission.DefaultPermission;
import org.bukkit.configuration.file.FileConfiguration;
import org.bukkit.configuration.file.YamlConfiguration;
import javax.inject.Inject;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.function.Supplier;
import java.util.stream.Collectors;
@@ -28,14 +23,12 @@ public class HelpMessagesService implements Reloadable {
private static final String DETAILED_DESCRIPTION_SUFFIX = ".detailedDescription";
private static final String DEFAULT_PERMISSIONS_PATH = "common.defaultPermissions.";
private final MessageFileCopier fileCopier;
private FileConfiguration fileConfiguration;
private String defaultFile;
private FileConfiguration defaultConfiguration;
private final MessageFileHandlerProvider messageFileHandlerProvider;
private MessageFileHandler messageFileHandler;
@Inject
HelpMessagesService(MessageFileCopier fileCopier) {
this.fileCopier = fileCopier;
HelpMessagesService(MessageFileHandlerProvider messageFileHandlerProvider) {
this.messageFileHandlerProvider = messageFileHandlerProvider;
reload();
}
@@ -47,7 +40,7 @@ public class HelpMessagesService implements Reloadable {
*/
public CommandDescription buildLocalizedDescription(CommandDescription command) {
final String path = getCommandPath(command);
if (fileConfiguration.get(path) == null) {
if (!messageFileHandler.hasSection(path)) {
// Messages file does not have a section for this command - return the provided command
return command;
}
@@ -73,49 +66,24 @@ public class HelpMessagesService implements Reloadable {
}
public String getMessage(HelpMessageKey key) {
String message = fileConfiguration.getString(key.getKey());
return message == null
? getDefault(key.getKey())
: message;
return messageFileHandler.getMessage(key.getKey());
}
public String getMessage(DefaultPermission defaultPermission) {
// e.g. {default_permissions_path}.opOnly for DefaultPermission.OP_ONLY
String path = DEFAULT_PERMISSIONS_PATH +
CaseFormat.UPPER_UNDERSCORE.to(CaseFormat.LOWER_CAMEL, defaultPermission.name());
String message = fileConfiguration.getString(path);
if (message != null) {
return message;
}
return getDefault(path);
return messageFileHandler.getMessage(path);
}
@Override
public void reload() {
MessageFileData fileData = fileCopier.initializeData(lang -> "messages/help_" + lang + ".yml");
this.fileConfiguration = YamlConfiguration.loadConfiguration(fileData.getFile());
this.defaultFile = fileData.getDefaultFile();
}
private String getDefault(String code) {
if (defaultFile == null) {
return getDefaultErrorMessage(code);
}
if (defaultConfiguration == null) {
InputStream stream = Messages.class.getResourceAsStream(defaultFile);
defaultConfiguration = YamlConfiguration.loadConfiguration(new InputStreamReader(stream));
}
String message = defaultConfiguration.getString(code);
return message == null ? getDefaultErrorMessage(code) : message;
}
private static String getDefaultErrorMessage(String code) {
return "Error retrieving message '" + code + "'";
messageFileHandler = messageFileHandlerProvider.initializeHandler(
lang -> "messages/help_" + lang + ".yml");
}
private String getText(String path, Supplier<String> defaultTextGetter) {
String message = fileConfiguration.getString(path);
String message = messageFileHandler.getMessageIfExists(path);
return message == null
? defaultTextGetter.get()
: message;
src/main/java/fr/xephi/authme/message/MessageFileCopier.java
-63
View File
@@ -1,63 +0,0 @@
package fr.xephi.authme.message;
import fr.xephi.authme.initialization.DataFolder;
import fr.xephi.authme.settings.Settings;
import fr.xephi.authme.settings.properties.PluginSettings;
import fr.xephi.authme.util.FileUtils;
import javax.inject.Inject;
import java.io.File;
import java.util.function.Function;
public class MessageFileCopier {
private static final String DEFAULT_LANGUAGE = "en";
private final File dataFolder;
private final Settings settings;
@Inject
MessageFileCopier(@DataFolder File dataFolder, Settings settings) {
this.dataFolder = dataFolder;
this.settings = settings;
}
public MessageFileData initializeData(Function<String, String> pathBuilder) {
String language = settings.getProperty(PluginSettings.MESSAGES_LANGUAGE);
return new MessageFileData(
initializeFile(language, pathBuilder),
pathBuilder.apply(DEFAULT_LANGUAGE));
}
private File initializeFile(String language, Function<String, String> pathBuilder) {
String filePath = pathBuilder.apply(language);
File file = new File(dataFolder, filePath);
if (FileUtils.copyFileFromResource(file, filePath)) {
return file;
}
String defaultFilePath = pathBuilder.apply(DEFAULT_LANGUAGE);
if (FileUtils.copyFileFromResource(file, defaultFilePath)) {
return file;
}
return null;
}
public static final class MessageFileData {
private final File file;
private final String defaultFile;
MessageFileData(File file, String defaultFile) {
this.file = file;
this.defaultFile = defaultFile;
}
public File getFile() {
return file;
}
public String getDefaultFile() {
return defaultFile;
}
}
}
src/main/java/fr/xephi/authme/message/MessageFileHandler.java
+89
View File
@@ -0,0 +1,89 @@
package fr.xephi.authme.message;
import fr.xephi.authme.ConsoleLogger;
import org.bukkit.configuration.file.FileConfiguration;
import org.bukkit.configuration.file.YamlConfiguration;
import java.io.File;
import java.io.InputStream;
import java.io.InputStreamReader;
/**
* Handles a YAML message file with a default file fallback.
*/
public final class MessageFileHandler {
// regular file
private final String filename;
private final FileConfiguration configuration;
// default file
private final String defaultFile;
private FileConfiguration defaultConfiguration;
/**
* Constructor.
*
* @param file the file to use for messages
* @param defaultFile the default file from the JAR to use if no message is found
*/
MessageFileHandler(File file, String defaultFile) {
this.filename = file.getName();
this.configuration = YamlConfiguration.loadConfiguration(file);
this.defaultFile = defaultFile;
}
/**
* Returns whether the message file configuration has an entry at the given path.
*
* @param path the path to verify
* @return true if an entry exists for the path in the messages file, false otherwise
*/
public boolean hasSection(String path) {
return configuration.get(path) != null;
}
/**
* Returns the message for the given key.
*
* @param key the key to retrieve the message for
* @return the message
*/
public String getMessage(String key) {
String message = configuration.getString(key);
if (message == null) {
ConsoleLogger.warning("Error getting message with key '" + key + "'. "
+ "Please verify your config file at '" + filename + "'");
return getDefault(key);
}
return message;
}
/**
* Returns the message for the given key only if it exists,
* i.e. without falling back to the default file.
*
* @param key the key to retrieve the message for
* @return the message, or {@code null} if not available
*/
public String getMessageIfExists(String key) {
return configuration.getString(key);
}
/**
* Gets the message from the default file.
*
* @param key the key to retrieve the message for
* @return the message from the default file
*/
private String getDefault(String key) {
if (defaultConfiguration == null) {
InputStream stream = Messages.class.getResourceAsStream(defaultFile);
defaultConfiguration = YamlConfiguration.loadConfiguration(new InputStreamReader(stream));
}
String message = defaultConfiguration.getString(key);
return message == null
? "Error retrieving message '" + key + "'"
: message;
}
}
src/main/java/fr/xephi/authme/message/MessageFileHandlerProvider.java
+67
View File
@@ -0,0 +1,67 @@
package fr.xephi.authme.message;
import com.google.common.annotations.VisibleForTesting;
import fr.xephi.authme.initialization.DataFolder;
import fr.xephi.authme.settings.Settings;
import fr.xephi.authme.settings.properties.PluginSettings;
import fr.xephi.authme.util.FileUtils;
import javax.inject.Inject;
import java.io.File;
import java.util.function.Function;
/**
* Injectable creator of {@link MessageFileHandler} instances.
*
* @see MessageFileHandler
*/
public class MessageFileHandlerProvider {
private static final String DEFAULT_LANGUAGE = "en";
@Inject
@DataFolder
private File dataFolder;
@Inject
private Settings settings;
MessageFileHandlerProvider() {
}
/**
* Initializes a message file handler with the messages file of the configured language.
* Ensures beforehand that the messages file exists or creates it otherwise.
*
* @param pathBuilder function taking the configured language code as argument and returning the messages file
* @return the message file handler
*/
public MessageFileHandler initializeHandler(Function<String, String> pathBuilder) {
String language = settings.getProperty(PluginSettings.MESSAGES_LANGUAGE);
return new MessageFileHandler(
initializeFile(language, pathBuilder),
pathBuilder.apply(DEFAULT_LANGUAGE));
}
/**
* Copies the messages file from the JAR if it doesn't exist.
*
* @param language the configured language code
* @param pathBuilder function returning message file name with language as argument
* @return the messages file to use
*/
@VisibleForTesting
File initializeFile(String language, Function<String, String> pathBuilder) {
String filePath = pathBuilder.apply(language);
File file = new File(dataFolder, filePath);
if (FileUtils.copyFileFromResource(file, filePath)) {
return file;
}
String defaultFilePath = pathBuilder.apply(DEFAULT_LANGUAGE);
if (FileUtils.copyFileFromResource(file, defaultFilePath)) {
return file;
}
return null;
}
}
src/main/java/fr/xephi/authme/message/Messages.java
+8 -44
View File
@@ -2,16 +2,10 @@ package fr.xephi.authme.message;
import fr.xephi.authme.ConsoleLogger;
import fr.xephi.authme.initialization.Reloadable;
import fr.xephi.authme.message.MessageFileCopier.MessageFileData;
import org.bukkit.ChatColor;
import org.bukkit.command.CommandSender;
import org.bukkit.configuration.file.FileConfiguration;
import org.bukkit.configuration.file.YamlConfiguration;
import javax.inject.Inject;
import java.io.File;
import java.io.InputStream;
import java.io.InputStreamReader;
/**
* Class for retrieving and sending translatable messages to players.
@@ -21,18 +15,15 @@ public class Messages implements Reloadable {
// Custom Authme tag replaced to new line
private static final String NEWLINE_TAG = "%nl%";
private final MessageFileCopier fileCopier;
private FileConfiguration configuration;
private String fileName;
private String defaultFile;
private FileConfiguration defaultConfiguration;
private final MessageFileHandlerProvider messageFileHandlerProvider;
private MessageFileHandler messageFileHandler;
/*
* Constructor.
*/
@Inject
Messages(MessageFileCopier fileCopier) {
this.fileCopier = fileCopier;
Messages(MessageFileHandlerProvider messageFileHandlerProvider) {
this.messageFileHandlerProvider = messageFileHandlerProvider;
reload();
}
@@ -87,15 +78,8 @@ public class Messages implements Reloadable {
* @return The message from the file
*/
private String retrieveMessage(MessageKey key) {
final String code = key.getKey();
String message = configuration.getString(code);
if (message == null) {
ConsoleLogger.warning("Error getting message with key '" + code + "'. "
+ "Please verify your config file at '" + fileName + "'");
return formatMessage(getDefault(code));
}
return formatMessage(message);
return formatMessage(
messageFileHandler.getMessage(key.getKey()));
}
/**
@@ -122,28 +106,8 @@ public class Messages implements Reloadable {
@Override
public void reload() {
MessageFileData messageFileData = fileCopier.initializeData(lang -> "messages/messages_" + lang + ".yml");
File messageFile = messageFileData.getFile();
this.configuration = YamlConfiguration.loadConfiguration(messageFile);
this.fileName = messageFile.getName();
this.defaultFile = messageFileData.getDefaultFile();
}
private String getDefault(String code) {
if (defaultFile == null) {
return getDefaultErrorMessage(code);
}
if (defaultConfiguration == null) {
InputStream stream = Messages.class.getResourceAsStream(defaultFile);
defaultConfiguration = YamlConfiguration.loadConfiguration(new InputStreamReader(stream));
}
String message = defaultConfiguration.getString(code);
return message == null ? getDefaultErrorMessage(code) : message;
}
private static String getDefaultErrorMessage(String code) {
return "Error retrieving message '" + code + "'";
this.messageFileHandler = messageFileHandlerProvider
.initializeHandler(lang -> "messages/messages_" + lang + ".yml");
}
private static String formatMessage(String message) {
src/main/java/fr/xephi/authme/settings/Settings.java
-45
View File
@@ -6,8 +6,6 @@ import com.github.authme.configme.migration.MigrationService;
import com.github.authme.configme.resource.PropertyResource;
import com.google.common.io.Files;
import fr.xephi.authme.ConsoleLogger;
import fr.xephi.authme.settings.properties.PluginSettings;
import fr.xephi.authme.util.FileUtils;
import java.io.File;
import java.io.IOException;
@@ -22,8 +20,6 @@ import static fr.xephi.authme.util.FileUtils.copyFileFromResource;
public class Settings extends SettingsManager {
private final File pluginFolder;
/** The file with the localized messages based on {@link PluginSettings#MESSAGES_LANGUAGE}. */
private File messagesFile;
private String[] welcomeMessage;
private String passwordEmailMessage;
private String recoveryCodeEmailMessage;
@@ -43,24 +39,6 @@ public class Settings extends SettingsManager {
loadSettingsFromFiles();
}
/**
* Return the messages file based on the messages language config.
*
* @return The messages file to read messages from
*/
public File getMessagesFile() {
return messagesFile;
}
/**
* Return the path to the default messages file within the JAR.
*
* @return The default messages file path
*/
public String getDefaultMessagesFile() {
return "/messages/messages_en.yml";
}
/**
* Return the text to use in email registrations.
*
@@ -89,7 +67,6 @@ public class Settings extends SettingsManager {
}
private void loadSettingsFromFiles() {
messagesFile = buildMessagesFile();
passwordEmailMessage = readFile("email.html");
recoveryCodeEmailMessage = readFile("recovery_code_email.html");
welcomeMessage = readFile("welcome.txt").split("\n");
@@ -101,28 +78,6 @@ public class Settings extends SettingsManager {
loadSettingsFromFiles();
}
private File buildMessagesFile() {
String languageCode = getProperty(PluginSettings.MESSAGES_LANGUAGE);
String filePath = buildMessagesFilePathFromCode(languageCode);
File messagesFile = new File(pluginFolder, filePath);
if (copyFileFromResource(messagesFile, filePath)) {
return messagesFile;
}
// File doesn't exist or couldn't be copied - try again with default, "en"
String defaultFilePath = buildMessagesFilePathFromCode("en");
File defaultFile = new File(pluginFolder, defaultFilePath);
copyFileFromResource(defaultFile, defaultFilePath);
// No matter the result, need to return a file
return defaultFile;
}
private static String buildMessagesFilePathFromCode(String language) {
return FileUtils.makePath("messages", "messages_" + language + ".yml");
}
/**
* Reads a file from the plugin folder or copies it from the JAR to the plugin folder.
*