Expose some server configuration values in the viewer

4 files changed, 190 insertions, 0 deletions

diff --git a/spark-common/src/main/java/me/lucko/spark/common/SparkPlugin.java b/spark-common/src/main/java/me/lucko/spark/common/SparkPlugin.java
index 5feb172..b817df1 100644
--- a/spark-common/src/main/java/me/lucko/spark/common/SparkPlugin.java
+++ b/spark-common/src/main/java/me/lucko/spark/common/SparkPlugin.java
@@ -24,6 +24,7 @@ import me.lucko.spark.api.Spark;
 import me.lucko.spark.common.command.sender.CommandSender;
 import me.lucko.spark.common.monitor.ping.PlayerPingProvider;
 import me.lucko.spark.common.platform.PlatformInfo;
+import me.lucko.spark.common.platform.serverconfig.ServerConfigProvider;
 import me.lucko.spark.common.sampler.ThreadDumper;
 import me.lucko.spark.common.tick.TickHook;
 import me.lucko.spark.common.tick.TickReporter;
@@ -133,6 +134,15 @@ public interface SparkPlugin {
     }
 
     /**
+     * Creates a server config provider.
+     *
+     * @return the server config provider function
+     */
+    default ServerConfigProvider createServerConfigProvider() {
+        return ServerConfigProvider.NO_OP;
+    }
+
+    /**
      * Gets information for the platform.
      *
      * @return information about the platform
diff --git a/spark-common/src/main/java/me/lucko/spark/common/platform/serverconfig/AbstractServerConfigProvider.java b/spark-common/src/main/java/me/lucko/spark/common/platform/serverconfig/AbstractServerConfigProvider.java
new file mode 100644
index 0000000..98db960
--- /dev/null
+++ b/spark-common/src/main/java/me/lucko/spark/common/platform/serverconfig/AbstractServerConfigProvider.java
@@ -0,0 +1,113 @@
+/*
+ * This file is part of spark.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package me.lucko.spark.common.platform.serverconfig;
+
+import com.google.common.collect.ImmutableMap;
+import com.google.gson.JsonElement;
+import com.google.gson.JsonObject;
+
+import java.io.IOException;
+import java.util.Arrays;
+import java.util.Deque;
+import java.util.LinkedList;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * Abstract implementation of {@link ServerConfigProvider}.
+ *
+ * <p>THis implementation is able to delete hidden paths from
+ * the configurations before they are sent to the viewer.</p>
+ *
+ * @param <T> the file type
+ */
+public abstract class AbstractServerConfigProvider<T extends Enum<T>> implements ServerConfigProvider {
+    private final Map<String, T> files;
+    private final List<String> hiddenPaths;
+
+    protected AbstractServerConfigProvider(Map<String, T> files, List<String> hiddenPaths) {
+        this.files = files;
+        this.hiddenPaths = hiddenPaths;
+    }
+
+    @Override
+    public final Map<String, JsonElement> loadServerConfigurations() {
+        ImmutableMap.Builder<String, JsonElement> builder = ImmutableMap.builder();
+
+        this.files.forEach((path, type) -> {
+            try {
+                JsonElement json = load(path, type);
+                delete(json, this.hiddenPaths);
+                builder.put(path, json);
+            } catch (Exception e) {
+                e.printStackTrace();
+            }
+        });
+
+        return builder.build();
+    }
+
+    /**
+     * Loads a file from the system.
+     *
+     * @param path the name of the file to load
+     * @param type the type of the file
+     * @return the loaded file
+     * @throws IOException if an error occurs performing i/o
+     */
+    protected abstract JsonElement load(String path, T type) throws IOException;
+
+    /**
+     * Deletes the given paths from the json element.
+     *
+     * @param json the json element
+     * @param paths the paths to delete
+     */
+    private static void delete(JsonElement json, List<String> paths) {
+        for (String path : paths) {
+            Deque<String> pathDeque = new LinkedList<>(Arrays.asList(path.split("\\.")));
+            delete(json, pathDeque);
+        }
+    }
+
+    private static void delete(JsonElement json, Deque<String> path) {
+        if (path.isEmpty()) {
+            return;
+        }
+        if (!json.isJsonObject()) {
+            return;
+        }
+
+        JsonObject jsonObject = json.getAsJsonObject();
+        String member = path.removeFirst();
+
+        if (!jsonObject.has(member)) {
+            return;
+        }
+
+        if (path.isEmpty()) {
+            jsonObject.remove(member);
+        } else {
+            delete(jsonObject.get(member), path);
+        }
+    }
+
+}
diff --git a/spark-common/src/main/java/me/lucko/spark/common/platform/serverconfig/ServerConfigProvider.java b/spark-common/src/main/java/me/lucko/spark/common/platform/serverconfig/ServerConfigProvider.java
new file mode 100644
index 0000000..1fc2391
--- /dev/null
+++ b/spark-common/src/main/java/me/lucko/spark/common/platform/serverconfig/ServerConfigProvider.java
@@ -0,0 +1,59 @@
+/*
+ * This file is part of spark.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package me.lucko.spark.common.platform.serverconfig;
+
+import com.google.gson.JsonElement;
+
+import java.util.Collections;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+/**
+ * Function to export server configuration files for access within the spark viewer.
+ */
+@FunctionalInterface
+public interface ServerConfigProvider {
+
+    /**
+     * Loads a map of the server configuration files.
+     *
+     * <p>The key is the name of the file and the value is a
+     * {@link JsonElement} of the contents.</p>
+     *
+     * @return the exported server configurations
+     */
+    Map<String, JsonElement> loadServerConfigurations();
+
+    default Map<String, String> exportServerConfigurations() {
+        return loadServerConfigurations().entrySet()
+                .stream()
+                .collect(Collectors.toMap(
+                        Map.Entry::getKey,
+                        e -> e.getValue().toString()
+                ));
+    }
+
+    /**
+     * A no-op implementation
+     */
+    ServerConfigProvider NO_OP = Collections::emptyMap;
+
+}
diff --git a/spark-common/src/main/java/me/lucko/spark/common/sampler/AbstractSampler.java b/spark-common/src/main/java/me/lucko/spark/common/sampler/AbstractSampler.java
index 34abdfa..9ae82e8 100644
--- a/spark-common/src/main/java/me/lucko/spark/common/sampler/AbstractSampler.java
+++ b/spark-common/src/main/java/me/lucko/spark/common/sampler/AbstractSampler.java
@@ -23,6 +23,7 @@ package me.lucko.spark.common.sampler;
 import me.lucko.spark.common.SparkPlatform;
 import me.lucko.spark.common.command.sender.CommandSender;
 import me.lucko.spark.common.monitor.memory.GarbageCollectorStatistics;
+import me.lucko.spark.common.platform.serverconfig.ServerConfigProvider;
 import me.lucko.spark.common.sampler.aggregator.DataAggregator;
 import me.lucko.spark.common.sampler.node.MergeMode;
 import me.lucko.spark.common.sampler.node.ThreadNode;
@@ -116,6 +117,13 @@ public abstract class AbstractSampler implements Sampler {
             e.printStackTrace();
         }
 
+        try {
+            ServerConfigProvider serverConfigProvider = platform.getPlugin().createServerConfigProvider();
+            metadata.putAllServerConfigurations(serverConfigProvider.exportServerConfigurations());
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
+
         proto.setMetadata(metadata);
     }