Registered under {@code console:notification/message} using - * {@link OutgoingRpcMethodBuilderAccessor#invokeRegister(Identifier)} to bypass - * the default {@code minecraft:notification/} namespace that the public - * {@code register(String)} overload would apply.
- * - *The {@code @SuppressWarnings("unchecked")} is required because the cast from - * {@link OutgoingRpcMethod.OutgoingRpcMethodBuilder} to - * {@link OutgoingRpcMethodBuilderAccessor} is a generic unchecked cast that is - * safe at runtime due to Mixin's bytecode transformation.
+ * The shared {@code entity} namespace used for all MSMP registrations. + * Attached to the running server in {@code SERVER_STARTED} and detached in {@code SERVER_STOPPED}. */ - @SuppressWarnings("unchecked") - public static final Holder.ReferenceThe appender is created programmatically so no {@code log4j2.xml} - * configuration is required.
- */ - private void registerLogAppender() { - org.apache.logging.log4j.core.LoggerContext ctx = (org.apache.logging.log4j.core.LoggerContext) LogManager.getContext(false); - org.apache.logging.log4j.core.Logger root = ctx.getRootLogger(); - ConsoleNotificationAppender appender = - ConsoleNotificationAppender.createAppender("ConsoleNotificationAppender"); - appender.start(); - root.addAppender(appender); - } - - /** - * Finds the {@link ManagementServer} instance held by the given {@link MinecraftServer} - * by traversing its class hierarchy via reflection. - * - *The field ({@code jsonRpcServer} in {@code DedicatedServer}) is not publicly - * accessible, so reflection is used to locate the first field of type - * {@link ManagementServer} in the class hierarchy.
- * - * @param server the running {@link MinecraftServer} instance - * @return the {@link ManagementServer} instance, or {@code null} if not found - */ - private static ManagementServer getManagementServer(MinecraftServer server) { - Class clazz = server.getClass(); - while (clazz != null) { - for (Field field : clazz.getDeclaredFields()) { - if (field.getType() == ManagementServer.class) { - try { - field.setAccessible(true); - ManagementServer ms = (ManagementServer) field.get(server); - if (ms != null) return ms; - } catch (Exception ignored) {} - } - } - clazz = clazz.getSuperclass(); - } - return null; - } - - /** - * Sends a console log notification to all connected MSMP clients. - * - *Called by {@link ConsoleNotificationAppender} for every intercepted log event. - * Does nothing if the {@link ManagementServer} is not yet available (i.e. before - * {@code SERVER_STARTED} or after {@code SERVER_STOPPED}).
- * - *The {@link ConsoleNotificationAppender.LogPayload} is mapped to a - * {@link ConsoleLogPayload} with {@code null} throwables replaced by empty strings - * to satisfy the non-null codec contract.
- * - * @param payload the log payload captured by {@link ConsoleNotificationAppender} - */ - public static void sendConsoleNotification(ConsoleNotificationAppender.LogPayload payload) { - if (managementServer == null) return; - - ConsoleLogPayload rpcPayload = new ConsoleLogPayload( - payload.timestamp(), - payload.level(), - payload.thread(), - payload.logger(), - payload.message(), - payload.throwable() != null ? payload.throwable() : "" - ); - - ((ManagementServerAccessor) managementServer) - .invokeForEachConnection(conn -> - conn.sendNotification(CONSOLE_MESSAGE, rpcPayload) - ); + Logger.info("Mod initialized."); } } diff --git a/src/main/java/dev/loat/msmp_console/config/Config.java b/src/main/java/dev/loat/msmp_console/config/Config.java index 61efcb9..871771c 100644 --- a/src/main/java/dev/loat/msmp_console/config/Config.java +++ b/src/main/java/dev/loat/msmp_console/config/Config.java @@ -1,105 +1,23 @@ package dev.loat.msmp_console.config; -import dev.loat.msmp_console.config.parser.YamlConfig; -import dev.loat.msmp_console.logging.Logger; +import dev.loat.config_lib.ConfigManager; +import dev.loat.msmp_console.config.files.MSMPEntityConfigFile; -import java.io.File; -import java.nio.file.Path; +public class Config { + + private Config() {} + + private static final String ROOT_DIRECTORY = "msmp/console"; + private static final ConfigManager CONFIG_MANAGER = new ConfigManager(ROOT_DIRECTORY); -/** - * Represents a configuration file. - * - * @paramThe appender is registered programmatically in {@link MSMPConsole#onInitialize()} - * and does not require any Log4j2 XML configuration.
- * - *A per-thread reentrancy guard ({@link #IS_APPENDING}) prevents infinite recursion - * in case {@link MSMPConsole#sendConsoleNotification(LogPayload)} itself produces - * a log event.
+ * A Log4j2 {@link Appender} that intercepts log events and forwards them to a consumer. */ @Plugin( name = "ConsoleNotificationAppender", @@ -38,25 +30,29 @@ public class ConsoleNotificationAppender extends AbstractAppender { private static final ThreadLocalEach endpoint is implemented in its own sub-package and registered here.
+ */ +public class Endpoints { + + private Endpoints() {} + + /** + * Registers all endpoints on the given {@link MSMPNamespace}. + * + * @param namespace The namespace to register all endpoints under + * @param msmpServer A supplier for the MSMPServer instance, used by some endpoints to subscribe to server events + */ + public static void register(MSMPNamespace namespace, SupplierFired when a new log event occurs.
+ * + *Example JSON representation:
+ *
+ * {
+ * "timestamp": ""
+ * "level": ""
+ * "thread": ""
+ * "logger": ""
+ * "message": ""
+ * "throwable": ""
+ * }
+ * Example JSON representation:
+ *
+ * { "command": "say Hello" }
+ * Example response:
+ *
+ * {
+ * "command": "say Hello",
+ * "success": true
+ * }
+ * Guarded by {@link #IS_APPENDING} to prevent infinite recursion. If the flag * is already set on the current thread, the event is silently dropped.
@@ -66,6 +82,8 @@ public static ConsoleNotificationAppender createAppender(String name, ConsumerBoth success and failure feedback are captured ({@link #acceptsSuccess()} and + * {@link #acceptsFailure()} both return {@code true}), and nothing is broadcast to + * operators ({@link #shouldInformAdmins()} returns {@code false}), since the caller + * already receives the full output directly in the RPC response.
+ */ +final class CapturingCommandSource implements CommandSource { + + private final ListExecutes an arbitrary command as if typed by an operator (permission level 4) and + * returns its textual feedback/error output together with a success indicator.
+ * + *The command is executed via {@link net.minecraft.commands.Commands#performPrefixedCommand}, + * which strips a leading {@code /} if present - so {@code command} may be sent either with + * or without the prefix.
+ */ public class Send { private Send() {} @@ -15,9 +30,30 @@ public static void register(MSMPNamespace namespace) { .register((server, client, params) -> { String command = params.command(); - // execute command on server, evaluate if successful and return response - - return new SendResponse(command, "", false); + CapturingCommandSource capturingSource = new CapturingCommandSource(); + + boolean[] successHolder = {false}; + + CommandSourceStack source = server.createCommandSourceStack() + .withSource(capturingSource) + .withPermission(PermissionSet.ALL_PERMISSIONS) + .withCallback((success, result) -> successHolder[0] = success); + + try { + server.getCommands().performPrefixedCommand(source, command); + } catch (Exception e) { + Logger.warning("console:send - failed to execute '%s': %s".formatted(command, e.getMessage())); + return new SendResponse(command, e.getMessage() != null ? e.getMessage() : "", false); + } + + String result = capturingSource.getOutput(); + boolean success = successHolder[0]; + + if (Config.getConfig().send.logCommandExecution) { + Logger.info("console:send - executed '%s'".formatted(command)); + } + + return new SendResponse(command, result, success); }); } } From dee5f73cb594306b5021ad0561ffe08f6af393de Mon Sep 17 00:00:00 2001 From: Mqx <62719703+Mqxx@users.noreply.github.com> Date: Sun, 12 Jul 2026 22:46:59 +0200 Subject: [PATCH 3/7] Delete ConsoleLogPayload.java --- .../loat/msmp_console/ConsoleLogPayload.java | 74 ------------------- 1 file changed, 74 deletions(-) delete mode 100644 src/main/java/dev/loat/msmp_console/ConsoleLogPayload.java diff --git a/src/main/java/dev/loat/msmp_console/ConsoleLogPayload.java b/src/main/java/dev/loat/msmp_console/ConsoleLogPayload.java deleted file mode 100644 index d966477..0000000 --- a/src/main/java/dev/loat/msmp_console/ConsoleLogPayload.java +++ /dev/null @@ -1,74 +0,0 @@ -package dev.loat.msmp_console; - -import com.mojang.serialization.Codec; -import com.mojang.serialization.codecs.RecordCodecBuilder; -import net.minecraft.server.jsonrpc.api.Schema; - - -/** - * Represents the payload of a console log notification sent over the - * Minecraft Server Management Protocol (MSMP). - * - *Each instance corresponds to a single log event captured by the - * {@link dev.loat.msmp_console.logging.ConsoleNotificationAppender} and - * transmitted as a JSON-RPC notification to all connected management clients - * via {@code console:notification/message}.
- * - *Example JSON representation:
- *{@code
- * {
- * "timestamp": "2026-03-21T15:06:06.146Z",
- * "level": "INFO",
- * "thread": "Server thread",
- * "logger": "net.minecraft.server.MinecraftServer",
- * "message": "Done (1.019s)! For help, type \"help\"",
- * "throwable": ""
- * }
- * }
- *
- * @param timestamp ISO-8601 timestamp of when the log event occurred
- * @param level log level of the event (e.g. {@code INFO}, {@code WARN}, {@code ERROR})
- * @param thread name of the thread that produced the log event
- * @param logger fully qualified name of the logger (usually the class name)
- * @param message the fully interpolated log message
- * @param throwable serialized stacktrace if an exception was attached, empty string otherwise
- */
-public record ConsoleLogPayload(
- String timestamp,
- String level,
- String thread,
- String logger,
- String message,
- String throwable
-) {
- /**
- * Mojang Serialization {@link Codec} for encoding and decoding
- * {@link ConsoleLogPayload} instances to and from JSON.
- *
- * {@code throwable} is optional in deserialization and defaults - * to an empty string if absent.
- */ - public static final CodecUsed by the MSMP discovery endpoint ({@code rpc.discover}) to expose - * the shape of the {@code console:notification/message} notification to - * connected clients.
- */ - public static final SchemaAttached directly to the root logger via {@link #register(Consumer)} - there is no + * Log4j2 config/plugin discovery involved, so no {@code @Plugin} metadata is needed.
*/ -@Plugin( - name = "ConsoleNotificationAppender", - category = Core.CATEGORY_NAME, - elementType = Appender.ELEMENT_TYPE -) public class ConsoleNotificationAppender extends AbstractAppender { /** - * Per-thread flag that prevents recursive invocation of {@link #append(LogEvent)}. - * Set to {@code true} while a notification is being dispatched, and reset to - * {@code false} in the {@code finally} block. + * Prevents feedback loops: if forwarding an event causes something to log again + * (e.g. an MSMP send failure), that new event must not be captured too. */ - private static final ThreadLocalFalls back to {@link Level#INFO} if the configured value is missing or cannot be - * parsed into a valid Log4j2 level.
- * - * @param eventLevel The level of the incoming log event - * @return {@code true} if the event should be forwarded, {@code false} if it should be dropped - */ - private static boolean isAtOrAboveMinLevel(Level eventLevel) { - String configuredLevel = Config.getConfig().log.level.toString(); - Level minLevel = Level.toLevel(configuredLevel, Level.INFO); - return eventLevel.isMoreSpecificThan(minLevel); + ((LoggerContext) LogManager.getContext(false)).getRootLogger().addAppender(appender); + + return appender; } /** @@ -82,12 +60,14 @@ private static boolean isAtOrAboveMinLevel(Level eventLevel) { @Override public void append(LogEvent event) { if (IS_APPENDING.get()) return; - if (!isAtOrAboveMinLevel(event.getLevel())) return; + + Level minLevel = Level.toLevel(Config.getConfig().log.level.toString(), Level.INFO); + if (!event.getLevel().isMoreSpecificThan(minLevel)) return; IS_APPENDING.set(true); try { if (listener != null) { - listener.accept(buildPayload(event)); + listener.accept(toPayload(event)); } } finally { IS_APPENDING.set(false); @@ -103,7 +83,7 @@ public void append(LogEvent event) { * @param event the log event to extract data from * @return a {@link LogPayload} containing all relevant fields of the event */ - private static LogPayload buildPayload(LogEvent event) { + private static LogPayload toPayload(LogEvent event) { String throwable = ""; if (event.getThrown() != null) { Throwable thrown = event.getThrown(); diff --git a/src/main/java/dev/loat/msmp_console/msmp/endpoints/log/notification/event/NotificationLogEvent.java b/src/main/java/dev/loat/msmp_console/msmp/endpoints/log/notification/event/NotificationLogEvent.java index d671583..a6491e1 100644 --- a/src/main/java/dev/loat/msmp_console/msmp/endpoints/log/notification/event/NotificationLogEvent.java +++ b/src/main/java/dev/loat/msmp_console/msmp/endpoints/log/notification/event/NotificationLogEvent.java @@ -2,8 +2,6 @@ import java.util.function.Supplier; -import org.apache.logging.log4j.LogManager; - import dev.loat.msmp.MSMPNamespace; import dev.loat.msmp.MSMPNotification; import dev.loat.msmp.MSMPServer; @@ -20,27 +18,19 @@ public static void register(MSMPNamespace namespace, Supplier