From d457dd82b46368a467d7733a43be849cfc5940de Mon Sep 17 00:00:00 2001 From: liam Date: Tue, 7 Mar 2023 01:18:10 +0000 Subject: [PATCH] added simple config system --- build.gradle | 2 + gradlew | 240 ++++++++++++++++++ gradlew.bat | 91 +++++++ .../java/cc/fascinated/wildaddons/Main.java | 16 ++ .../wildaddons/client/WildAddonsClient.java | 15 ++ .../wildaddons/statistic/Statistic.java | 95 ++++++- .../fascinated/wildaddons/utils/Config.java | 52 ++++ 7 files changed, 510 insertions(+), 1 deletion(-) create mode 100755 gradlew create mode 100644 gradlew.bat create mode 100644 src/main/java/cc/fascinated/wildaddons/utils/Config.java diff --git a/build.gradle b/build.gradle index af37161..1c3a560 100644 --- a/build.gradle +++ b/build.gradle @@ -23,6 +23,8 @@ dependencies { // Fabric API. This is technically optional, but you probably want it anyway. modImplementation "net.fabricmc.fabric-api:fabric-api:${project.fabric_version}" + implementation('org.spongepowered:configurate-hocon:4.0.0') + compileOnly("org.projectlombok:lombok:1.18.26") annotationProcessor("org.projectlombok:lombok:1.18.26") } diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..a69d9cb --- /dev/null +++ b/gradlew @@ -0,0 +1,240 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..53a6b23 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,91 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/src/main/java/cc/fascinated/wildaddons/Main.java b/src/main/java/cc/fascinated/wildaddons/Main.java index bf570c1..6fb80c2 100644 --- a/src/main/java/cc/fascinated/wildaddons/Main.java +++ b/src/main/java/cc/fascinated/wildaddons/Main.java @@ -1,11 +1,20 @@ package cc.fascinated.wildaddons; +import cc.fascinated.wildaddons.utils.Config; import lombok.Getter; import net.fabricmc.api.ModInitializer; import net.minecraft.client.MinecraftClient; import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; +import org.spongepowered.configurate.CommentedConfigurationNode; +import org.spongepowered.configurate.ConfigurationNode; +import org.spongepowered.configurate.ConfigurationOptions; +import org.spongepowered.configurate.hocon.HoconConfigurationLoader; +import org.spongepowered.configurate.loader.ConfigurationLoader; +import org.spongepowered.configurate.serialize.SerializationException; +import java.io.File; +import java.nio.file.Path; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; @@ -15,10 +24,17 @@ public class Main implements ModInitializer { @Getter private static final ExecutorService executorService = Executors.newCachedThreadPool(); @Getter private static final MinecraftClient minecraftClient = MinecraftClient.getInstance(); + @Getter private static final Config statisticsConfig; + static { + String dirName = minecraftClient.runDirectory.getAbsolutePath() + File.separator + "wildaddons"; + statisticsConfig = new Config(dirName, "statistics.conf"); + } + /** * Runs the mod initializer. */ @Override public void onInitialize() { + } } diff --git a/src/main/java/cc/fascinated/wildaddons/client/WildAddonsClient.java b/src/main/java/cc/fascinated/wildaddons/client/WildAddonsClient.java index afc7b99..d2404c4 100644 --- a/src/main/java/cc/fascinated/wildaddons/client/WildAddonsClient.java +++ b/src/main/java/cc/fascinated/wildaddons/client/WildAddonsClient.java @@ -1,10 +1,22 @@ package cc.fascinated.wildaddons.client; +import cc.fascinated.wildaddons.Main; import cc.fascinated.wildaddons.addon.AddonManager; import cc.fascinated.wildaddons.event.EventManager; import cc.fascinated.wildaddons.listener.PlayerListener; +import cc.fascinated.wildaddons.statistic.Statistic; import cc.fascinated.wildaddons.tpsmonitor.TpsMonitor; import net.fabricmc.api.ClientModInitializer; +import org.spongepowered.configurate.CommentedConfigurationNode; +import org.spongepowered.configurate.ConfigurateException; +import org.spongepowered.configurate.ConfigurationNode; +import org.spongepowered.configurate.ConfigurationOptions; +import org.spongepowered.configurate.hocon.HoconConfigurationLoader; +import org.spongepowered.configurate.loader.ConfigurationLoader; +import org.spongepowered.configurate.serialize.SerializationException; + +import java.io.File; +import java.io.IOException; public class WildAddonsClient implements ClientModInitializer { @@ -15,6 +27,9 @@ public class WildAddonsClient implements ClientModInitializer { public void onInitializeClient() { new AddonManager(); + Statistic.loadStatistics(Main.getStatisticsConfig().getNode()); + Statistic.initSaver(); + EventManager.registerListener(new PlayerListener()); EventManager.registerListener(new TpsMonitor()); } diff --git a/src/main/java/cc/fascinated/wildaddons/statistic/Statistic.java b/src/main/java/cc/fascinated/wildaddons/statistic/Statistic.java index 762d52c..d0d1793 100644 --- a/src/main/java/cc/fascinated/wildaddons/statistic/Statistic.java +++ b/src/main/java/cc/fascinated/wildaddons/statistic/Statistic.java @@ -1,9 +1,17 @@ package cc.fascinated.wildaddons.statistic; +import cc.fascinated.wildaddons.Main; +import cc.fascinated.wildaddons.utils.Config; import lombok.Getter; import lombok.RequiredArgsConstructor; +import org.spongepowered.configurate.ConfigurateException; +import org.spongepowered.configurate.ConfigurationNode; +import org.spongepowered.configurate.serialize.SerializationException; import java.util.HashMap; +import java.util.List; +import java.util.Timer; +import java.util.TimerTask; @Getter @RequiredArgsConstructor public enum Statistic { @@ -14,13 +22,27 @@ public enum Statistic { /** * The in memory storage for all statistics */ - private final HashMap statistics = new HashMap<>(); + @Getter private static final HashMap statistics = new HashMap<>(); + + /** + * If the values is dirty, then we can save to disk + */ + private static boolean dirty; /** * The key used in the storage */ private final String key; + /** + * Gets the value of this statistic. + * + * @return the value + */ + public int get() { + return statistics.computeIfAbsent(this, (e) -> 0); + } + /** * Increment this statistic. */ @@ -37,5 +59,76 @@ public enum Statistic { int current = statistics.computeIfAbsent(this, (e) -> 0); current += amount; statistics.put(this, current); + dirty = true; + } + + public static void initSaver() { + Config statisticsConfig = Main.getStatisticsConfig(); + new Timer().scheduleAtFixedRate(new TimerTask() { + @Override + public void run() { + if (!dirty) { + return; + } + for (Statistic value : values()) { + try { + statisticsConfig.getNode().node(value.key).set(value.get()); + } catch (SerializationException e) { + throw new RuntimeException(e); + } + } + try { + statisticsConfig.save(); + } catch (ConfigurateException e) { + throw new RuntimeException(e); + } + + dirty = false; + Main.LOGGER.info("Saved statistics."); + } + }, 60_000L, 60_000L); + } + + /** + * Loads statistics from disk + * + * @param node the configuration node to load from + */ + public static void loadStatistics(ConfigurationNode node) { + try { + List keys = node.getList(String.class); + if (keys == null) { + return; + } + for (String key : keys) { + ConfigurationNode keyNode = node.node(key); + if (keyNode == null) { + continue; + } + Integer value = keyNode.get(Integer.class, 0); + if (value == null) { + continue; + } + statistics.put(Statistic.FILTERED_MESSAGES.getStatisticFromKey(key), value); + } + + } catch (SerializationException e) { + throw new RuntimeException(e); + } + } + + /** + * Gets a statistic from the key + * + * @param key the key to check against + * @return the statistic if found, otherwise null + */ + public Statistic getStatisticFromKey(String key) { + for (Statistic value : values()) { + if (value.key.equalsIgnoreCase(key)) { + return value; + } + } + return null; } } diff --git a/src/main/java/cc/fascinated/wildaddons/utils/Config.java b/src/main/java/cc/fascinated/wildaddons/utils/Config.java new file mode 100644 index 0000000..b7aa5ac --- /dev/null +++ b/src/main/java/cc/fascinated/wildaddons/utils/Config.java @@ -0,0 +1,52 @@ +package cc.fascinated.wildaddons.utils; + +import cc.fascinated.wildaddons.Main; +import lombok.Getter; +import org.spongepowered.configurate.CommentedConfigurationNode; +import org.spongepowered.configurate.ConfigurateException; +import org.spongepowered.configurate.ConfigurationNode; +import org.spongepowered.configurate.ConfigurationOptions; +import org.spongepowered.configurate.hocon.HoconConfigurationLoader; +import org.spongepowered.configurate.loader.ConfigurationLoader; + +import java.io.File; +import java.io.IOException; + +public class Config { + + private ConfigurationLoader configurationLoader; + @Getter private ConfigurationNode node; + + /** + * Creates a new configuration + * + * @param dirName the directory path + * @param fileName the file name + */ + public Config(String dirName, String fileName) { + File dir = new File(dirName); + if (!dir.exists()) { + dir.mkdirs(); + } + File file = new File(dir.getAbsolutePath() + File.separator + fileName); + if (!file.exists()) { + try { + file.createNewFile(); + } catch (IOException e) { + throw new RuntimeException(e); + } + } + + configurationLoader = HoconConfigurationLoader.builder().file(file).prettyPrinting(true).build(); + node = configurationLoader.createNode(ConfigurationOptions.defaults()); + } + + /** + * Saves the config file. + * + * @throws ConfigurateException thrown if there was an error saving + */ + public void save() throws ConfigurateException { + configurationLoader.save(node); + } +}