#1085 Improve of help translation files

- Avoid logging an error if a help_{lang}.yml file does not exist in the JAR
- No longer suggest /authme messages for updating the help translation
- Create consistency test to ensure that all help_{lang}.yml files in the JAR have entries for all help sections / messages / default permissions

src/main/java/fr/xephi/authme/message/MessageFileHandler.java

@@ -1,6 +1,7 @@
 package fr.xephi.authme.message;
 
 import fr.xephi.authme.ConsoleLogger;
+import fr.xephi.authme.util.FileUtils;
 import org.bukkit.configuration.file.FileConfiguration;
 import org.bukkit.configuration.file.YamlConfiguration;
 
@@ -16,6 +17,7 @@ public class MessageFileHandler {
     // regular file
     private final String filename;
     private final FileConfiguration configuration;
+    private final String updateAddition;
     // default file
     private final String defaultFile;
     private FileConfiguration defaultConfiguration;
@@ -25,11 +27,15 @@ public class MessageFileHandler {
      *
      * @param file the file to use for messages
      * @param defaultFile the default file from the JAR to use if no message is found
+     * @param updateCommand command to update the messages file (nullable) to show in error messages
      */
-    public MessageFileHandler(File file, String defaultFile) {
+    public MessageFileHandler(File file, String defaultFile, String updateCommand) {
         this.filename = file.getName();
         this.configuration = YamlConfiguration.loadConfiguration(file);
         this.defaultFile = defaultFile;
+        this.updateAddition = updateCommand == null
+            ? ""
+            : " (or run " + updateCommand + ")";
     }
 
     /**
@@ -53,7 +59,7 @@ public class MessageFileHandler {
 
         if (message == null) {
             ConsoleLogger.warning("Error getting message with key '" + key + "'. "
-                + "Please update your config file '" + filename + "' (or run /authme messages)");
+                + "Please update your config file '" + filename + "'" + updateAddition);
             return getDefault(key);
         }
         return message;
@@ -78,7 +84,7 @@ public class MessageFileHandler {
      */
     private String getDefault(String key) {
         if (defaultConfiguration == null) {
-            InputStream stream = MessageFileHandler.class.getClassLoader().getResourceAsStream(defaultFile);
+            InputStream stream = FileUtils.getResourceFromJar(defaultFile);
             defaultConfiguration = YamlConfiguration.loadConfiguration(new InputStreamReader(stream));
         }
         String message = defaultConfiguration.getString(key);

src/main/java/fr/xephi/authme/message/MessageFileHandlerProvider.java

@@ -36,10 +36,23 @@ public class MessageFileHandlerProvider {
      * @return the message file handler
      */
     public MessageFileHandler initializeHandler(Function<String, String> pathBuilder) {
+        return initializeHandler(pathBuilder, null);
+    }
+
+    /**
+     * 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
+     * @param updateCommand command to run to update the languages file (nullable)
+     * @return the message file handler
+     */
+    public MessageFileHandler initializeHandler(Function<String, String> pathBuilder, String updateCommand) {
         String language = settings.getProperty(PluginSettings.MESSAGES_LANGUAGE);
         return new MessageFileHandler(
             initializeFile(language, pathBuilder),
-            pathBuilder.apply(DEFAULT_LANGUAGE));
+            pathBuilder.apply(DEFAULT_LANGUAGE),
+            updateCommand);
     }
 
     /**
@@ -53,7 +66,8 @@ public class MessageFileHandlerProvider {
     File initializeFile(String language, Function<String, String> pathBuilder) {
         String filePath = pathBuilder.apply(language);
         File file = new File(dataFolder, filePath);
-        if (FileUtils.copyFileFromResource(file, filePath)) {
+        // Check that JAR file exists to avoid logging an error
+        if (FileUtils.getResourceFromJar(filePath) != null && FileUtils.copyFileFromResource(file, filePath)) {
             return file;
         }
 

src/main/java/fr/xephi/authme/message/Messages.java

@@ -107,7 +107,7 @@ public class Messages implements Reloadable {
     @Override
     public void reload() {
         this.messageFileHandler = messageFileHandlerProvider
-            .initializeHandler(lang -> "messages/messages_" + lang + ".yml");
+            .initializeHandler(lang -> "messages/messages_" + lang + ".yml", "/authme messages");
     }
 
     private static String formatMessage(String message) {

src/main/resources/messages/help_br.yml

@@ -4,6 +4,7 @@
 # -------------------------------------------------------
 # Lista de textos usados na seção de ajuda:
 common:
+    header: '==========[ Ajuda AuthMeReloaded ]=========='
     optional: 'Opcional'
     hasPermission: 'Você tem permissão'
     noPermission: 'Sem Permissão'