Alex/KittyBot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

+ Interim csv parsing additions

Browse Source
This commit is contained in:
Matthew Cech
2019-06-26 23:13:20 -07:00
parent 70263d23e6
commit 610fbdc809
26 changed files with 1265 additions and 176 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/core/BaseLocFile.java
+7
View File
@@ -2,6 +2,8 @@ package core;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.List;
import dataStructures.TaggedPairStore;
import utils.GlobalLog;
import utils.LogFilter;
@@ -138,4 +140,9 @@ public abstract class BaseLocFile
{
return stringStore.toString();
}
public List<ConfigItem> toConfigList();
{
}
}
src/core/CommandEnabler.java
+1 -1
View File
@@ -13,7 +13,7 @@ import utils.LogFilter;
// commands that are being looked up will behave slightly differently so trimming
// rules for this file are different than the localization ones - this is more
// aggresive with whitespace removal.
public class CommandEnabler extends BaseKeyValueFile implements IConfigSection
public class CommandEnabler extends BaseKeyValueFile implements DEPRECATED_IConfigSection
{
// Config/const variables
public static final String enabled = "1";
src/core/Config.java
+9 -150
View File
@@ -1,172 +1,31 @@
package core;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.List;
import java.util.Vector;
import utils.GlobalLog;
import utils.LogFilter;
import utils.io.FileMonitor;
import utils.io.FileUtils;
public class Config
{
private static final String filepath = Constants.AssetDirectory + Constants.ConfigFilename;
{
ConfigCSV configCSV;
List<IConfigSection> sections;
public static Config instance;
// Private
private Vector<IConfigSection> sections;
private FileMonitor monitoredConfigFile;
public Config()
{
if(instance == null)
{
// Create local variables
sections = new Vector<IConfigSection>();
configCSV = new ConfigCSV(sections, "./config.csv");
configCSV.writeFile();
// Add all sections
sections.add(new LocCommands());
sections.add(new LocStrings());
sections.add(new CommandEnabler());
// Read file in and parse everything out
performStartup();
// Being monitoring configs and mark this as the instance now that it's made
monitoredConfigFile = new FileMonitor(filepath);
instance = this;
}
else
{
GlobalLog.error(LogFilter.Core, "You can't have two of the following: " + this.getClass().getSimpleName());
System.out.println("Only one config class is allowed, period. Aborting.");
System.out.flush();
System.exit(-1);
}
}
// Perform startup
private void performStartup()
{
File configFile = new File(filepath);
if(configFile.exists())
{
reformConfig(configFile);
}
else
{
try
{
configFile.createNewFile();
}
catch (IOException e)
{
GlobalLog.error(LogFilter.Core, "Failed to load config or create empty config at " + filepath);
System.exit(-1);
}
}
}
public static final String sectionStart = "[[";
public static final String sectionEnd = "]]";
public static final String headerStart = "[";
public static final String headerEnd = "]";
public static final String pairSplit = "=";
public static final String pairSeparator = "\n";
private void reformConfig(File configFile)
{
// Read and update
String configContents = FileUtils.readContent(configFile);
readConfigs(configContents);
// Form updated data as necessary for autogeneration
String output = combineConfigs();
// Write to file.
try
{
OutputStreamWriter fileWriter = new OutputStreamWriter(new FileOutputStream(configFile), StandardCharsets.UTF_8);
fileWriter.write(output);
fileWriter.close();
}
catch (IOException e)
{
GlobalLog.error(LogFilter.Core, "Config writing failure.");
GlobalLog.error(LogFilter.Core, e.getMessage());
}
}
public void readConfigs(String fullContents)
{
String[] str = fullContents.split(pairSeparator);
HashMap<String, String> parsedSections = new HashMap<String, String>();
String currentHeader = "";
for(int i = 0; i < str.length; ++i)
{
String line = str[i].trim();
if(line.startsWith(sectionStart) && line.endsWith(sectionEnd))
{
currentHeader = line.substring(sectionStart.length(), line.length() - sectionEnd.length());
}
else
{
String sectionContents = parsedSections.getOrDefault(currentHeader, "");
parsedSections.put(currentHeader, sectionContents + line + pairSeparator);
}
}
for(int i = 0; i < sections.size(); ++i)
{
IConfigSection section = sections.get(i);
String header = section.getHeader();
String content = parsedSections.getOrDefault(header, null);
if(content != null)
{
section.read(content);
}
else
{
GlobalLog.warn(LogFilter.Core, "Mismatch during config parsing - expected but did not find " + header);
}
}
}
public String combineConfigs()
{
String output = "";
for(int i = 0; i < sections.size(); ++i)
{
// If not the first section, add spacing!
if(i != 0)
{
for(int spacing = 0; spacing < 3; ++spacing)
{
output += pairSeparator;
}
}
IConfigSection section = sections.get(i);
output += sectionStart + section.getHeader() + sectionEnd + pairSeparator;
output += section.write() + pairSeparator;
}
return output;
}
public void upkeep()
{
monitoredConfigFile.update((monitoredFile) -> {
File configFile = new File(filepath);
reformConfig(configFile);
});
}
}
src/core/ConfigCSV.java
+146
View File
@@ -0,0 +1,146 @@
package core;
import java.io.File;
import java.io.IOException;
import java.io.Reader;
import java.io.Writer;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Vector;
import com.opencsv.CSVReader;
import com.opencsv.CSVReaderBuilder;
import com.opencsv.CSVWriter;
public class ConfigCSV
{
// Variables
private final String path;
private List<ConfigItem> fileContents;
// Constructor
public ConfigCSV(List<IConfigSection> sections, String path)
{
this.path = path;
fileContents = new Vector<ConfigItem>();
read(path);
}
// Creates the writer in the format we desire.
public static CSVWriter makeWriter(Writer writer)
{
return new CSVWriter(writer,
CSVWriter.DEFAULT_SEPARATOR,
CSVWriter.DEFAULT_QUOTE_CHARACTER,
'\\',
CSVWriter.DEFAULT_LINE_END);
}
// Read the file. This is internal only.
private void read(String filepath)
{
try
{
File configFile = new File(filepath);
// If we had to create a new file, write the default header into it.
if(configFile.createNewFile())
{
Writer writer = Files.newBufferedWriter(Paths.get(path));
CSVWriter csvWriter = makeWriter(writer);
csvWriter.writeNext(ConfigItem.header);
csvWriter.close();
}
Reader reader = Files.newBufferedReader(Paths.get(filepath));
CSVReader csvReader = new CSVReaderBuilder(reader).withSkipLines(1).build();
fileContents.clear();
// Read contents. As for the line number, we not only start counting at 1, we also skip the header.
int line = 2;
String[] record = null;
while ((record = csvReader.readNext()) != null)
{
if(record.length < ConfigItem.items)
{
System.out.println("Incorrect number of items on line " + line + " in " + path);
continue;
}
ConfigItem parsedLine = new ConfigItem(record[0], record[1], record[2]);
System.out.println(parsedLine);
fileContents.add(parsedLine);
++line;
}
// Close down
csvReader.close();
reader.close();
}
catch (Exception e)
{
e.printStackTrace();
}
}
// Get a copy of the internal items
public List<ConfigItem> getItems()
{
return Arrays.asList((ConfigItem[])fileContents.toArray());
}
// Set the internal items
public void setItems(List<ConfigItem> newList)
{
fileContents = newList;
}
// Write out the file, header then body.
public void writeFile()
{
try
{
Writer writer = Files.newBufferedWriter(Paths.get(path));
CSVWriter csvWriter = makeWriter(writer);
csvWriter.writeNext(ConfigItem.header);
for(ConfigItem item : fileContents)
{
csvWriter.writeNext(item.getAll());
}
csvWriter.close();
}
catch (IOException e)
{
e.printStackTrace();
}
}
// Static utility function
public static Map<String, List<ConfigItem>> groupByColumn(List<ConfigItem> items, int columnNumber)
{
if(items == null || items.size() <= 0 || columnNumber < 0)
{
return null;
}
Map<String, List<ConfigItem>> sortedItems = new HashMap<String, List<ConfigItem>>();
for(ConfigItem item : items)
{
String key = item.getColumn(columnNumber);
List<ConfigItem> list = sortedItems.getOrDefault(key, new Vector<ConfigItem>());
list.add(item);
sortedItems.put(key, list);
}
return sortedItems;
}
}
src/core/ConfigItem.java
+40
View File
@@ -0,0 +1,40 @@
package core;
// Everything in here must be a string type. This class does not
// perform any parsing past naming columns, and just holds the raw data.
public class ConfigItem
{
public String type;
public String key;
public String value;
public static final int items = 3;
public static final String[] header = {"Type","Key","Value"};
public ConfigItem(String type, String key, String value)
{
this.type = type;
this.key = key;
this.value = value;
}
public String getColumn(int column)
{
switch(column)
{
case 0: return type;
case 1: return key;
case 2: return value;
default: return null;
}
}
public String[] getAll()
{
return new String[] {type, key, value};
}
public String toString()
{
return "type: " + type + ", key: " + key + ", value: " + value;
}
}
src/core/DEPRECATED_Config.java
+172
View File
@@ -0,0 +1,172 @@
package core;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.Vector;
import utils.GlobalLog;
import utils.LogFilter;
import utils.io.FileMonitor;
import utils.io.FileUtils;
public class DEPRECATED_Config
{
private static final String filepath = Constants.AssetDirectory + Constants.ConfigFilename;
public static DEPRECATED_Config instance;
// Private
private Vector<DEPRECATED_IConfigSection> sections;
private FileMonitor monitoredConfigFile;
public DEPRECATED_Config()
{
if(instance == null)
{
// Create local variables
sections = new Vector<DEPRECATED_IConfigSection>();
// Add all sections
sections.add(new LocCommands());
sections.add(new LocStrings());
sections.add(new CommandEnabler());
// Read file in and parse everything out
performStartup();
// Being monitoring configs and mark this as the instance now that it's made
monitoredConfigFile = new FileMonitor(filepath);
instance = this;
}
else
{
GlobalLog.error(LogFilter.Core, "You can't have two of the following: " + this.getClass().getSimpleName());
System.exit(-1);
}
}
// Perform startup
private void performStartup()
{
File configFile = new File(filepath);
if(configFile.exists())
{
reformConfig(configFile);
}
else
{
try
{
configFile.createNewFile();
}
catch (IOException e)
{
GlobalLog.error(LogFilter.Core, "Failed to load config or create empty config at " + filepath);
System.exit(-1);
}
}
}
public static final String sectionStart = "[[";
public static final String sectionEnd = "]]";
public static final String headerStart = "[";
public static final String headerEnd = "]";
public static final String pairSplit = "=";
public static final String pairSeparator = "\n";
private void reformConfig(File configFile)
{
// Read and update
String configContents = FileUtils.readContent(configFile);
readConfigs(configContents);
// Form updated data as necessary for autogeneration
String output = combineConfigs();
// Write to file.
try
{
OutputStreamWriter fileWriter = new OutputStreamWriter(new FileOutputStream(configFile), StandardCharsets.UTF_8);
fileWriter.write(output);
fileWriter.close();
}
catch (IOException e)
{
GlobalLog.error(LogFilter.Core, "Config writing failure.");
GlobalLog.error(LogFilter.Core, e.getMessage());
}
}
public void readConfigs(String fullContents)
{
String[] str = fullContents.split(pairSeparator);
HashMap<String, String> parsedSections = new HashMap<String, String>();
String currentHeader = "";
for(int i = 0; i < str.length; ++i)
{
String line = str[i].trim();
if(line.startsWith(sectionStart) && line.endsWith(sectionEnd))
{
currentHeader = line.substring(sectionStart.length(), line.length() - sectionEnd.length());
}
else
{
String sectionContents = parsedSections.getOrDefault(currentHeader, "");
parsedSections.put(currentHeader, sectionContents + line + pairSeparator);
}
}
for(int i = 0; i < sections.size(); ++i)
{
DEPRECATED_IConfigSection section = sections.get(i);
String header = section.getHeader();
String content = parsedSections.getOrDefault(header, null);
if(content != null)
{
section.read(content);
}
else
{
GlobalLog.warn(LogFilter.Core, "Mismatch during config parsing - expected but did not find " + header);
}
}
}
public String combineConfigs()
{
String output = "";
for(int i = 0; i < sections.size(); ++i)
{
// If not the first section, add spacing!
if(i != 0)
{
for(int spacing = 0; spacing < 3; ++spacing)
{
output += pairSeparator;
}
}
DEPRECATED_IConfigSection section = sections.get(i);
output += sectionStart + section.getHeader() + sectionEnd + pairSeparator;
output += section.write() + pairSeparator;
}
return output;
}
public void upkeep()
{
monitoredConfigFile.update((monitoredFile) -> {
File configFile = new File(filepath);
reformConfig(configFile);
});
}
}
src/core/DEPRECATED_IConfigSection.java
+8
View File
@@ -0,0 +1,8 @@
package core;
public abstract interface DEPRECATED_IConfigSection
{
public abstract String getHeader();
public abstract void read(String contents);
public abstract String write();
}
src/core/IConfigSection.java
+11 -3
View File
@@ -1,8 +1,16 @@
package core;
import java.util.List;
// A config section is a unit of config that holds data.
public abstract interface IConfigSection
{
public abstract String getHeader();
public abstract void read(String contents);
public abstract String write();
// Get the title of the section
public abstract String getSectionTitle();
// Provide the parsed key and values for a given section
public abstract void consume(List<ConfigItem> pairs);
// Ask the section to produce a list of pairs to be written out to the key and value columns in the csv
public abstract List<ConfigItem> produce();
}
src/core/LocCommands.java
+24 -6
View File
@@ -1,6 +1,8 @@
package core;
import java.util.ArrayList;
import java.util.List;
import utils.GlobalLog;
import utils.LogFilter;
import dataStructures.Pair;
@@ -43,20 +45,36 @@ public class LocCommands extends BaseLocFile implements IConfigSection
instance.stringStore.forEach((pair) -> raw.add((String)((Pair<?, ?>)pair).First ));
return raw;
}
//
// @Override
// public String getHeader() {
// return HeaderName;
// }
//
// @Override
// public void read(String contents) {
// updateLocFromString(contents);
// scrapeAll();
// }
//
// @Override
// public String write() {
// return toString();
// }
@Override
public String getHeader() {
public String getSectionTitle() {
return HeaderName;
}
@Override
public void read(String contents) {
updateLocFromString(contents);
public void consume(List<ConfigItem> pairs) {
scrapeAll();
}
@Override
public String write() {
return toString();
public List<ConfigItem> produce() {
// TODO Auto-generated method stub
return;
}
}
src/core/LocStrings.java
+23 -5
View File
@@ -1,5 +1,7 @@
package core;
import java.util.List;
import utils.GlobalLog;
import utils.LogFilter;
@@ -41,18 +43,34 @@ public class LocStrings extends BaseLocFile implements IConfigSection
}
@Override
public String getHeader() {
public String getSectionTitle() {
return HeaderName;
}
@Override
public void read(String contents) {
updateLocFromString(contents);
public void consume(List<ConfigItem> pairs) {
scrapeAll();
}
@Override
public String write() {
return toString();
public List<ConfigItem> produce() {
// TODO Auto-generated method stub
return null;
}
// @Override
// public String getHeader() {
// return HeaderName;
// }
//
// @Override
// public void read(String contents) {
// updateLocFromString(contents);
// scrapeAll();
// }
//
// @Override
// public String write() {
// return toString();
// }
}
src/core/ObjectBuilderFactory.java
+2 -2
View File
@@ -58,7 +58,7 @@ public class ObjectBuilderFactory
@SuppressWarnings("unused") private static LocCommands locCommands;
// Config
@SuppressWarnings("unused") private static Config config;
@SuppressWarnings("unused") private static DEPRECATED_Config config;
// Lazy initialization multithreaded mutex stuff to prevent explosions.
// TODO: Investigate using 'synchronized' instead potentially
@@ -88,7 +88,7 @@ public class ObjectBuilderFactory
// Start by reading from things that are external. Because
// we require these things to be resolved before the rest of the application,
// we place them here.
config = new Config();
config = new DEPRECATED_Config();
}
finally
{
src/core/SubCommand.java
+2 -2
View File
@@ -18,7 +18,7 @@ public abstract class SubCommand
private void Reject(KittyUser user, String reason)
{
GlobalLog.Warn(LogFilter.Command, this.getClass().getSimpleName() + " from " + user.name + " rejected due to command's " + reason);
GlobalLog.warn(LogFilter.Command, this.getClass().getSimpleName() + " from " + user.name + " rejected due to command's " + reason);
}
private boolean CanCall(KittyGuild guild, KittyChannel channel, KittyUser user)
@@ -31,7 +31,7 @@ public abstract class SubCommand
//TODO: ADD CHANNEL CHECK HERE
if(user.GetRole().getValue() >= roleLevel.getValue())
if(user.getRole().getValue() >= roleLevel.getValue())
{
return true;
}
src/core/SubCommandFormattable.java
+2 -2
View File
@@ -33,8 +33,8 @@ public class SubCommandFormattable
public void Call(Response res)
{
if(resEmbed == null)
res.Call(resString);
res.send(resString);
else
res.CallEmbed(resEmbed);
res.send(resEmbed);
}
}
src/core/SubCommandFramework.java
+2 -2
View File
@@ -20,9 +20,9 @@ public class SubCommandFramework
{
name = name.toLowerCase();
if(commands.put(name, command) != null)
GlobalLog.Error("Multiple registration of a name with name '" + name + "'!");
GlobalLog.error("Multiple registration of a name with name '" + name + "'!");
GlobalLog.Log("Registered " + name);
GlobalLog.log("Registered " + name);
}
public SubCommandFormattable run(KittyGuild guild, KittyChannel channel, KittyUser user, String input)
src/main/Main.java
+1 -1
View File
@@ -7,7 +7,7 @@ import javax.security.auth.login.LoginException;
import core.CharacterManager;
import core.CommandEnabler;
import core.CommandManager;
import core.Config;
import core.DEPRECATED_Config;
import core.DatabaseManager;
import core.ObjectBuilderFactory;
import core.RPManager;
src/main/Superintendent.java
+2 -2
View File
@@ -2,7 +2,7 @@ package main;
import java.util.concurrent.atomic.AtomicInteger;
import core.Config;
import core.DEPRECATED_Config;
import core.DatabaseManager;
import core.RPManager;
import core.Stats;
@@ -74,7 +74,7 @@ public class Superintendent
public static boolean perCommandUpkeepPre()
{
// Upkeep the config file monitoring
Config.instance.upkeep();
DEPRECATED_Config.instance.upkeep();
return true;
}