LoginSystem/src/test/java/tools/messages/VerifyMessagesTask.java

package tools.messages;

import com.google.common.collect.Multimap;
import de.bananaco.bpermissions.imp.YamlConfiguration;
import fr.xephi.authme.message.MessageKey;
import fr.xephi.authme.util.StringUtils;
import org.bukkit.configuration.file.FileConfiguration;
import tools.utils.ToolTask;
import tools.utils.ToolsConstants;

import java.io.File;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Scanner;
import java.util.Set;
import java.util.regex.Pattern;

import static tools.utils.FileIoUtils.listFilesOrThrow;

/**
 * Task to verify the keys in the messages files.
 */
public final class VerifyMessagesTask implements ToolTask {

    /** The folder containing the message files. */
    private static final String MESSAGES_FOLDER = ToolsConstants.MAIN_RESOURCES_ROOT + "messages/";
    /** Pattern of the message file names. */
    private static final Pattern MESSAGE_FILE_PATTERN = Pattern.compile("messages_[a-z]{2,7}\\.yml");
    /** File to get default messages from (assumes that it is complete). */
    private static final String DEFAULT_MESSAGES_FILE = MESSAGES_FOLDER + "messages_en.yml";

    @Override
    public String getTaskName() {
        return "verifyMessages";
    }

    @Override
    public void execute(Scanner scanner) {
        System.out.println("Check a specific file only?");
        System.out.println("Enter the language code for a specific file (e.g. 'es' for messages_es.yml)");
        System.out.println("- Empty line will check all files in the resources messages folder (default)");
        String inputFile = scanner.nextLine();

        System.out.println("Add any missing keys to files? ['y' = yes]");
        boolean addMissingKeys = "y".equalsIgnoreCase(scanner.nextLine());

        List<File> messageFiles;
        if (StringUtils.isEmpty(inputFile)) {
            messageFiles = getMessagesFiles();
        } else {
            File customFile = new File(MESSAGES_FOLDER, "messages_" + inputFile + ".yml");
            messageFiles = Collections.singletonList(customFile);
        }

        FileConfiguration defaultFileConfiguration = null;
        if (addMissingKeys) {
            defaultFileConfiguration = YamlConfiguration.loadConfiguration(new File(DEFAULT_MESSAGES_FILE));
        }

        // Verify the given files
        for (File file : messageFiles) {
            System.out.println("Verifying '" + file.getName() + "'");
            MessageFileVerifier verifier = new MessageFileVerifier(file);
            if (addMissingKeys) {
                outputVerificationResults(verifier);
                updateMessagesFile(file, verifier, defaultFileConfiguration);
            } else {
                outputVerificationResults(verifier);
            }
        }

        if (messageFiles.size() > 1) {
            System.out.println("Checked " + messageFiles.size() + " files");
        }
    }

    /**
     * Outputs the verification results to the console.
     *
     * @param verifier the verifier whose results should be output
     */
    private static void outputVerificationResults(MessageFileVerifier verifier) {
        Set<MessageKey> missingKeys = verifier.getMissingKeys();
        if (!missingKeys.isEmpty()) {
            System.out.println("  Missing keys: " + missingKeys);
        }

        Set<String> unknownKeys = verifier.getUnknownKeys();
        if (!unknownKeys.isEmpty()) {
            System.out.println("  Unknown keys: " + unknownKeys);
        }

        Multimap<MessageKey, String> missingTags = verifier.getMissingTags();
        for (Map.Entry<MessageKey, String> entry : missingTags.entries()) {
            System.out.println("  Missing tag '" + entry.getValue() + "' in entry '" + entry.getKey() + "'");
        }
    }

    /**
     * Updates a messages file to have the same order as the default file and to contain all
     * failed verifications as comments.
     *
     * @param file the file to update
     * @param verifier the verifier whose results should be used
     * @param defaultConfiguration default file configuration to retrieve missing texts from
     */
    private static void updateMessagesFile(File file, MessageFileVerifier verifier,
                                           FileConfiguration defaultConfiguration) {
        if (verifier.hasErrors()) {
            MessagesFileWriter.writeToFileWithCommentsFromDefault(file, defaultConfiguration);
        }
    }


    private static List<File> getMessagesFiles() {
        File[] files = listFilesOrThrow(new File(MESSAGES_FOLDER));
        List<File> messageFiles = new ArrayList<>();
        for (File file : files) {
            if (MESSAGE_FILE_PATTERN.matcher(file.getName()).matches()) {
                messageFiles.add(file);
            }
        }
        if (messageFiles.isEmpty()) {
            throw new IllegalStateException("Error getting message files: list of files is empty");
        }
        return messageFiles;
    }
}