Adds code for config migration with comment retaining
All checks were successful
KnarCraft/KnarLib/pipeline/head This commit looks good
All checks were successful
KnarCraft/KnarLib/pipeline/head This commit looks good
This commit is contained in:
@@ -0,0 +1,296 @@
|
||||
package net.knarcraft.knarlib.config;
|
||||
|
||||
import net.knarcraft.knarlib.util.ConfigHelper;
|
||||
import org.bukkit.configuration.ConfigurationSection;
|
||||
import org.bukkit.configuration.InvalidConfigurationException;
|
||||
import org.bukkit.configuration.file.FileConfiguration;
|
||||
import org.bukkit.configuration.file.YamlConfiguration;
|
||||
import org.bukkit.plugin.Plugin;
|
||||
import org.jetbrains.annotations.NotNull;
|
||||
import org.jetbrains.annotations.Nullable;
|
||||
|
||||
import java.io.File;
|
||||
import java.io.IOException;
|
||||
import java.util.ArrayList;
|
||||
import java.util.HashSet;
|
||||
import java.util.List;
|
||||
import java.util.Set;
|
||||
import java.util.logging.Level;
|
||||
|
||||
/**
|
||||
* A YAML configuration which retains all comments
|
||||
*
|
||||
* <p>This configuration converts all comments to YAML values when loaded, which all start with comment_. When saved,
|
||||
* those YAML values are converted to normal text comments. This ensures that the comments aren't removed by the
|
||||
* YamlConfiguration during its parsing.</p>
|
||||
*
|
||||
* <p>Note: When retrieving a configuration section, that will include comments that start with "comment_". You should
|
||||
* filter those before parsing input, or use "getKeysWithoutComments".</p>
|
||||
*
|
||||
* <p>Also note: This class was originally made for the Stargate rewrite, but can be used for any configuration file.
|
||||
* In order to make sure the comments are retained, always use this class instead of plugin.getConfig() whenever code
|
||||
* might choose to save the configuration.</p>
|
||||
*
|
||||
* @author Kristian Knarvik
|
||||
* @author Thorin
|
||||
*/
|
||||
public class StargateYamlConfiguration extends YamlConfiguration {
|
||||
|
||||
private static final String START_OF_COMMENT_LINE = "[HASHTAG]";
|
||||
private static final String END_OF_COMMENT = "_endOfComment_";
|
||||
private static final String START_OF_COMMENT = "comment_";
|
||||
|
||||
@Override
|
||||
@NotNull
|
||||
@Deprecated
|
||||
@SuppressWarnings("deprecation")
|
||||
protected String buildHeader() {
|
||||
return "";
|
||||
}
|
||||
|
||||
@Override
|
||||
@NotNull
|
||||
public String saveToString() {
|
||||
// Convert YAML comments to normal comments
|
||||
return this.convertYAMLMappingsToComments(super.saveToString());
|
||||
}
|
||||
|
||||
@Override
|
||||
public void loadFromString(@NotNull String contents) throws InvalidConfigurationException {
|
||||
// Convert normal comments to YAML comments to prevent them from disappearing
|
||||
super.loadFromString(this.convertCommentsToYAMLMappings(contents));
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads the configuration of the given plugin
|
||||
*
|
||||
* @param plugin <p>The plugin to load the configuration from</p>
|
||||
* @return <p>The loaded configuration, or null if unsuccessful</p>
|
||||
*/
|
||||
@SuppressWarnings("unused")
|
||||
@Nullable
|
||||
public static StargateYamlConfiguration loadConfiguration(@NotNull Plugin plugin) {
|
||||
StargateYamlConfiguration configuration = new StargateYamlConfiguration();
|
||||
configuration.options().copyDefaults(true);
|
||||
try {
|
||||
configuration.load(new File(plugin.getDataFolder(), ConfigHelper.getConfigFile()));
|
||||
return configuration;
|
||||
} catch (IOException | InvalidConfigurationException exception) {
|
||||
plugin.getLogger().log(Level.SEVERE, "Unable to load the configuration! Message: " + exception.getMessage());
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Saves the given configuration
|
||||
*
|
||||
* @param plugin <p>The plugin to save configuration for</p>
|
||||
* @param configuration <p>The configuration to save</p>
|
||||
* @return <p>True if the configuration was successfully saved</p>
|
||||
*/
|
||||
@SuppressWarnings("unused")
|
||||
public static boolean saveConfiguration(@NotNull Plugin plugin, @NotNull StargateYamlConfiguration configuration) {
|
||||
try {
|
||||
configuration.save(new File(plugin.getDataFolder(), ConfigHelper.getConfigFile()));
|
||||
return true;
|
||||
} catch (IOException exception) {
|
||||
plugin.getLogger().log(Level.SEVERE, "Unable to save the configuration! Message: " + exception.getMessage());
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a configuration section's keys, without any comment entries
|
||||
*
|
||||
* @param configurationSection <p>The configuration section to get keys for</p>
|
||||
* @param deep <p>Whether to get keys for child elements as well</p>
|
||||
* @return <p>The configuration section's keys, with comment entries removed</p>
|
||||
*/
|
||||
public static Set<String> getKeysWithoutComments(@NotNull ConfigurationSection configurationSection, boolean deep) {
|
||||
Set<String> keys = new HashSet<>(configurationSection.getKeys(deep));
|
||||
keys.removeIf(key -> key.matches(START_OF_COMMENT + "[0-9]+"));
|
||||
return keys;
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads a file with comments, and recreates them into yaml mappings
|
||||
*
|
||||
* <p>A mapping follows this format: comment_{CommentNumber}: "The comment"
|
||||
* This needs to be done as comments otherwise get removed using
|
||||
* the {@link FileConfiguration#save(File)} method. The config
|
||||
* needs to be saved if a config value has changed.</p>
|
||||
*
|
||||
* @param configString <p>The config string to convert</p>
|
||||
*/
|
||||
@NotNull
|
||||
private String convertCommentsToYAMLMappings(@NotNull String configString) {
|
||||
StringBuilder yamlBuilder = new StringBuilder();
|
||||
List<String> currentComment = new ArrayList<>();
|
||||
int commentId = 0;
|
||||
int previousIndentation = 0;
|
||||
|
||||
for (String line : configString.split("\n")) {
|
||||
String trimmed = line.trim();
|
||||
if (trimmed.startsWith("#")) {
|
||||
// Store the indentation of the block
|
||||
if (currentComment.isEmpty()) {
|
||||
previousIndentation = getIndentation(line);
|
||||
}
|
||||
//Temporarily store the comment line
|
||||
addComment(currentComment, trimmed);
|
||||
} else {
|
||||
addYamlString(yamlBuilder, currentComment, line, previousIndentation, commentId);
|
||||
commentId++;
|
||||
previousIndentation = 0;
|
||||
}
|
||||
}
|
||||
return yamlBuilder.toString();
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a YAML string to the given string builder
|
||||
*
|
||||
* @param yamlBuilder <p>The string builder used for building YAML</p>
|
||||
* @param currentComment <p>The comment to add as a YAML string</p>
|
||||
* @param line <p>The current line</p>
|
||||
* @param previousIndentation <p>The indentation of the current block comment</p>
|
||||
* @param commentId <p>The id of the comment</p>
|
||||
*/
|
||||
private void addYamlString(@NotNull StringBuilder yamlBuilder, @NotNull List<String> currentComment,
|
||||
@NotNull String line, int previousIndentation, int commentId) {
|
||||
String trimmed = line.trim();
|
||||
//Write the full formatted comment to the StringBuilder
|
||||
if (!currentComment.isEmpty()) {
|
||||
int indentation = trimmed.isEmpty() ? previousIndentation : getIndentation(line);
|
||||
generateCommentYAML(yamlBuilder, currentComment, commentId, indentation);
|
||||
currentComment.clear();
|
||||
}
|
||||
//Add the non-comment line assuming it isn't empty
|
||||
if (!trimmed.isEmpty()) {
|
||||
yamlBuilder.append(line).append("\n");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds the given comment to the given list
|
||||
*
|
||||
* @param commentParts <p>The list to add to</p>
|
||||
* @param comment <p>The comment to add</p>
|
||||
*/
|
||||
private void addComment(@NotNull List<String> commentParts, @NotNull String comment) {
|
||||
if (comment.startsWith("# ")) {
|
||||
commentParts.add(comment.replaceFirst("# ", START_OF_COMMENT_LINE));
|
||||
} else {
|
||||
commentParts.add(comment.replaceFirst("#", START_OF_COMMENT_LINE));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates a YAML-compatible string for one comment block
|
||||
*
|
||||
* @param yamlBuilder <p>The string builder to add the generated YAML to</p>
|
||||
* @param commentLines <p>The lines of the comment to convert into YAML</p>
|
||||
* @param commentId <p>The unique id of the comment</p>
|
||||
* @param indentation <p>The indentation to add to every line</p>
|
||||
*/
|
||||
private void generateCommentYAML(@NotNull StringBuilder yamlBuilder, @NotNull List<String> commentLines,
|
||||
int commentId, int indentation) {
|
||||
String subIndentation = this.addIndentation(indentation + 2);
|
||||
//Add the comment start marker
|
||||
yamlBuilder.append(this.addIndentation(indentation)).append(START_OF_COMMENT).append(commentId).append(": |\n");
|
||||
for (String commentLine : commentLines) {
|
||||
//Add each comment line with the proper indentation
|
||||
yamlBuilder.append(subIndentation).append(commentLine).append("\n");
|
||||
}
|
||||
//Add the comment end marker
|
||||
yamlBuilder.append(subIndentation).append(subIndentation).append(END_OF_COMMENT).append("\n");
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts the internal YAML mapping format to a readable config file
|
||||
*
|
||||
* <p>The internal YAML structure is converted to a string with the same format as a standard configuration file.
|
||||
* The internal structure has comments in the format: START_OF_COMMENT + id + multi-line YAML string +
|
||||
* END_OF_COMMENT.</p>
|
||||
*
|
||||
* @param yamlString <p>A string using the YAML format</p>
|
||||
* @return <p>The corresponding comment string</p>
|
||||
*/
|
||||
@NotNull
|
||||
private String convertYAMLMappingsToComments(@NotNull String yamlString) {
|
||||
StringBuilder finalText = new StringBuilder();
|
||||
|
||||
String[] lines = yamlString.split("\n");
|
||||
for (int currentIndex = 0; currentIndex < lines.length; currentIndex++) {
|
||||
String line = lines[currentIndex];
|
||||
String possibleComment = line.trim();
|
||||
|
||||
if (possibleComment.startsWith(START_OF_COMMENT)) {
|
||||
//Add an empty line before every comment block
|
||||
finalText.append("\n");
|
||||
currentIndex = readComment(finalText, lines, currentIndex + 1, getIndentation(line));
|
||||
} else {
|
||||
//Output the configuration key
|
||||
finalText.append(line).append("\n");
|
||||
}
|
||||
}
|
||||
|
||||
return finalText.toString().trim();
|
||||
}
|
||||
|
||||
/**
|
||||
* Fully reads a comment
|
||||
*
|
||||
* @param builder <p>The string builder to write to</p>
|
||||
* @param lines <p>The lines to read from</p>
|
||||
* @param startIndex <p>The index to start reading from</p>
|
||||
* @param commentIndentation <p>The indentation of the read comment</p>
|
||||
* @return <p>The index containing the next non-comment line</p>
|
||||
*/
|
||||
private int readComment(@NotNull StringBuilder builder, @NotNull String[] lines, int startIndex,
|
||||
int commentIndentation) {
|
||||
for (int currentIndex = startIndex; currentIndex < lines.length; currentIndex++) {
|
||||
String line = lines[currentIndex];
|
||||
String possibleComment = line.trim();
|
||||
if (!line.contains(END_OF_COMMENT)) {
|
||||
possibleComment = possibleComment.replace(START_OF_COMMENT_LINE, "");
|
||||
builder.append(addIndentation(commentIndentation)).append("# ").append(possibleComment).append("\n");
|
||||
} else {
|
||||
return currentIndex;
|
||||
}
|
||||
}
|
||||
|
||||
return startIndex;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a string containing the given indentation
|
||||
*
|
||||
* @param indentationSpaces <p>The number spaces to use for indentation</p>
|
||||
* @return <p>A string containing the number of spaces specified</p>
|
||||
*/
|
||||
@NotNull
|
||||
private String addIndentation(int indentationSpaces) {
|
||||
return " ".repeat(Math.max(0, indentationSpaces));
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Gets the indentation (number of spaces) of the given line
|
||||
*
|
||||
* @param line <p>The line to get indentation of</p>
|
||||
* @return <p>The number of spaces in the line's indentation</p>
|
||||
*/
|
||||
private int getIndentation(@NotNull String line) {
|
||||
int spacesFound = 0;
|
||||
for (char aCharacter : line.toCharArray()) {
|
||||
if (aCharacter == ' ') {
|
||||
spacesFound++;
|
||||
} else {
|
||||
break;
|
||||
}
|
||||
}
|
||||
return spacesFound;
|
||||
}
|
||||
|
||||
}
|
||||
162
src/main/java/net/knarcraft/knarlib/util/ConfigHelper.java
Normal file
162
src/main/java/net/knarcraft/knarlib/util/ConfigHelper.java
Normal file
@@ -0,0 +1,162 @@
|
||||
package net.knarcraft.knarlib.util;
|
||||
|
||||
import net.knarcraft.knarlib.config.StargateYamlConfiguration;
|
||||
import net.knarcraft.knarlib.property.ColorConversion;
|
||||
import org.bukkit.configuration.ConfigurationSection;
|
||||
import org.bukkit.configuration.InvalidConfigurationException;
|
||||
import org.bukkit.configuration.MemorySection;
|
||||
import org.bukkit.configuration.file.FileConfiguration;
|
||||
import org.bukkit.configuration.file.YamlConfiguration;
|
||||
import org.bukkit.plugin.Plugin;
|
||||
import org.jetbrains.annotations.NotNull;
|
||||
|
||||
import java.io.File;
|
||||
import java.io.IOException;
|
||||
import java.io.InputStream;
|
||||
import java.util.Map;
|
||||
import java.util.logging.Level;
|
||||
|
||||
/**
|
||||
* A helper class for dealing with a plugin's configuration file
|
||||
*/
|
||||
@SuppressWarnings("unused")
|
||||
public final class ConfigHelper {
|
||||
|
||||
private static final String CONFIG_FILE = "config.yml";
|
||||
private static final String BACKUP_CONFIG_FILE = "config.yml.old";
|
||||
private static final String MIGRATION_FILE = "config-migrations.txt";
|
||||
|
||||
private ConfigHelper() {
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the relative string path of the configuration file
|
||||
*
|
||||
* @return <p>The configuration file path</p>
|
||||
*/
|
||||
public static String getConfigFile() {
|
||||
return CONFIG_FILE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Saves any missing configuration values to the given plugin's configuration
|
||||
*
|
||||
* @param plugin <p>The plugin to add missing default values to</p>
|
||||
*/
|
||||
public static void saveDefaults(@NotNull Plugin plugin) {
|
||||
plugin.saveDefaultConfig();
|
||||
plugin.getConfig().options().copyDefaults(true);
|
||||
plugin.reloadConfig();
|
||||
plugin.saveConfig();
|
||||
}
|
||||
|
||||
/**
|
||||
* Changes all configuration values from the old name to the new name
|
||||
*
|
||||
* <p>Note: This method expects a file "config-migrations.txt" in the resources directory that contains mappings:
|
||||
* oldKey=replacementKey in order to migrate from old to new configuration values.
|
||||
* The old configuration file will be saved to config.yml.old</p>
|
||||
*
|
||||
* @param plugin <p>The plugin to migrate the configuration for</p>
|
||||
* @return <p>True if the migration succeeded without any issues</p>
|
||||
*/
|
||||
public static boolean migrateConfig(@NotNull Plugin plugin) {
|
||||
File dataFolder = plugin.getDataFolder();
|
||||
//Save the old config just in case something goes wrong
|
||||
try {
|
||||
StargateYamlConfiguration currentConfiguration = new StargateYamlConfiguration();
|
||||
currentConfiguration.load(new File(dataFolder, CONFIG_FILE));
|
||||
currentConfiguration.save(new File(dataFolder, BACKUP_CONFIG_FILE));
|
||||
} catch (IOException | InvalidConfigurationException exception) {
|
||||
plugin.getLogger().log(Level.WARNING, "Unable to save old backup and do migration");
|
||||
return false;
|
||||
}
|
||||
|
||||
//Load old and new configuration
|
||||
plugin.reloadConfig();
|
||||
FileConfiguration oldConfiguration = plugin.getConfig();
|
||||
InputStream configStream = FileHelper.getInputStreamForInternalFile("/" + CONFIG_FILE);
|
||||
if (configStream == null) {
|
||||
plugin.getLogger().log(Level.SEVERE, "Could not migrate the configuration, as the internal " +
|
||||
"configuration could not be read!");
|
||||
return false;
|
||||
}
|
||||
YamlConfiguration newConfiguration = StargateYamlConfiguration.loadConfiguration(
|
||||
FileHelper.getBufferedReaderFromInputStream(configStream));
|
||||
|
||||
//Read all available config migrations
|
||||
Map<String, String> migrationFields;
|
||||
try {
|
||||
InputStream migrationStream = FileHelper.getInputStreamForInternalFile("/" + MIGRATION_FILE);
|
||||
if (migrationStream == null) {
|
||||
plugin.getLogger().log(Level.SEVERE, "Could not migrate the configuration, as the internal " +
|
||||
"migration paths could not be read!");
|
||||
return false;
|
||||
}
|
||||
migrationFields = FileHelper.readKeyValuePairs(FileHelper.getBufferedReaderFromInputStream(migrationStream),
|
||||
"=", ColorConversion.NONE);
|
||||
} catch (IOException exception) {
|
||||
plugin.getLogger().log(Level.WARNING, "Unable to load config migration file");
|
||||
return false;
|
||||
}
|
||||
|
||||
//Replace old config names with the new ones
|
||||
for (String key : migrationFields.keySet()) {
|
||||
if (oldConfiguration.contains(key)) {
|
||||
migrateProperty(migrationFields, key, oldConfiguration);
|
||||
}
|
||||
}
|
||||
|
||||
// Copy all keys to the new config
|
||||
for (String key : StargateYamlConfiguration.getKeysWithoutComments(oldConfiguration, true)) {
|
||||
if (oldConfiguration.get(key) instanceof MemorySection) {
|
||||
continue;
|
||||
}
|
||||
newConfiguration.set(key, oldConfiguration.get(key));
|
||||
}
|
||||
|
||||
try {
|
||||
newConfiguration.save(new File(dataFolder, CONFIG_FILE));
|
||||
} catch (IOException exception) {
|
||||
plugin.getLogger().log(Level.WARNING, "Unable to save migrated config");
|
||||
return false;
|
||||
}
|
||||
|
||||
plugin.reloadConfig();
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Migrates one configuration property
|
||||
*
|
||||
* @param migrationFields <p>The configuration fields to be migrated</p>
|
||||
* @param key <p>The key/path of the property to migrate</p>
|
||||
* @param oldConfiguration <p>The original pre-migration configuration</p>
|
||||
*/
|
||||
private static void migrateProperty(@NotNull Map<String, String> migrationFields, @NotNull String key,
|
||||
@NotNull FileConfiguration oldConfiguration) {
|
||||
String newPath = migrationFields.get(key);
|
||||
Object oldValue = oldConfiguration.get(key);
|
||||
if (!newPath.trim().isEmpty()) {
|
||||
if (oldConfiguration.isConfigurationSection(key)) {
|
||||
// Copy each value of a configuration section
|
||||
ConfigurationSection sourceSection = oldConfiguration.getConfigurationSection(key);
|
||||
ConfigurationSection destinationSection = oldConfiguration.createSection(newPath);
|
||||
if (sourceSection == null) {
|
||||
return;
|
||||
}
|
||||
for (String path : StargateYamlConfiguration.getKeysWithoutComments(sourceSection, true)) {
|
||||
destinationSection.set(path, sourceSection.get(path));
|
||||
}
|
||||
} else {
|
||||
// Copy the value to the new path
|
||||
oldConfiguration.set(newPath, oldValue);
|
||||
}
|
||||
}
|
||||
|
||||
// Remove the old path's value
|
||||
oldConfiguration.set(key, null);
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user