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;