Merge pull request #9 from NeonAngelThreads/web-support

Web dashboard backend API server implement.

Author: NeonAngelThreads

.idea/misc.xml

@@ -436,13 +436,14 @@ Message APIs are aimed to help you to connect one or more bot between bots, that
 **Step 1:**    
 Defining a message listener on a receiver bot:  
 ExampleMessageListener.java
+
 ```java
 import org.angellock.impl.events.IListener;
-import org.angellock.impl.events.dolphin.MessageBroadcastEvent;
+import org.angellock.impl.api.events.MessageBroadcastEvent;
 
 public class ExampleMessageListener implements IListener {
     @EventHandler
-    public void onMessage(MessageBroadcastEvent event){
+    public void onMessage(MessageBroadcastEvent event) {
         log.info("message payload: {}", event.getMessage());
         // Do something...
     }

PluginDocs.md

@@ -87,6 +87,19 @@
             <version>RELEASE</version>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>com.sun.net.httpserver</groupId>
+            <artifactId>http</artifactId>
+            <version>20070405</version>
+            <scope>system</scope>
+            <systemPath>${java.home}/lib/jrt-fs.jar</systemPath>
+        </dependency>
+        <!-- Java WebSocket -->
+        <dependency>
+            <groupId>org.java-websocket</groupId>
+            <artifactId>Java-WebSocket</artifactId>
+            <version>1.5.4</version>
+        </dependency>
     </dependencies>
 
     <build>

pom.xml

@@ -39,6 +39,7 @@
 import org.angellock.impl.plugin.PluginManager;
 import org.angellock.impl.plugin.SessionProvider;
 import org.angellock.impl.util.ConsoleTokens;
+import org.angellock.impl.util.ProxyObject;
 import org.angellock.impl.util.TranslatableUtil;
 import org.geysermc.mcprotocollib.network.BuiltinFlags;
 import org.geysermc.mcprotocollib.network.ProxyInfo;
@@ -47,8 +48,12 @@
 import org.geysermc.mcprotocollib.protocol.MinecraftProtocol;
 import org.geysermc.mcprotocollib.protocol.codec.MinecraftPacket;
 import org.geysermc.mcprotocollib.protocol.data.game.entity.player.GameMode;
+import org.jetbrains.annotations.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.slf4j.Marker;
+import org.slf4j.MarkerFactory;
+import org.slf4j.spi.LoggingEventBuilder;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -150,7 +155,6 @@ public void connect(){
         }
 
         this.messageManager = new ChatMessageManager(this);
-
         this.serverSession.addListener((IConnectListener) event -> onJoin());
         this.serverSession.addListener(new DisconnectReasonHandler(this));
         this.serverSession.addListener(new ServerChatCommandHandler(this.commands));
@@ -246,6 +250,10 @@ public AbstractRobot withProfileName(String name) {
         return this;
     }
 
+    public Marker getBotLabel(){
+        return MarkerFactory.getMarker(this.getInfoHelper().getName());
+    }
+
     public Map<UUID, Player> getOnlinePlayers() {
         return PlayerTracker.getOnlinePlayers();
     }

src/main/java/org/angellock/impl/AbstractRobot.java

@@ -60,18 +60,18 @@ private boolean isCommand(String msg){
     private void sendMessagePacket(String message){
         if (!this.isCommand(message)) {
             MinecraftPacket msgPacket = new ServerboundChatPacket(message, Instant.now().toEpochMilli(), System.currentTimeMillis(), null, 0, new BitSet());
-            log.info(TranslatableUtil.getFormattedMessage(EnumSystemEvents.CHAT_MESSAGE_SEND, message));
+            log.info(instance.getBotLabel(), TranslatableUtil.getFormattedMessage(EnumSystemEvents.CHAT_MESSAGE_SEND, message));
             this.instance.sendPacket(msgPacket);
         } else {
             try {
                 boolean valid = this.instance.commandManager.callCommand(message, instance);
                 if (!valid) {
                     MinecraftPacket cmd = new ServerboundChatCommandPacket(message.replaceFirst("/", ""));
-                    log.info(TranslatableUtil.getFormattedMessage(EnumSystemEvents.CHAT_COMMAND_SEND, message));
+                    log.info(instance.getBotLabel(), TranslatableUtil.getFormattedMessage(EnumSystemEvents.CHAT_COMMAND_SEND, message));
                     this.instance.sendPacket(cmd);
                 }
             } catch (Exception e) {
-                log.warn("An exception occurred: &7{}", e.getMessage());
+                log.warn(instance.getBotLabel(), "An exception occurred: &7{}", e.getMessage());
             }
         }
     }

src/main/java/org/angellock/impl/ChatMessageManager.java

@@ -56,7 +56,7 @@ public static class OtherSettings {
 
     public DolphinConfig mergeCommandOptions(Map<String, Object> commandLines) {
         for (Map.Entry<String, Object> opt : commandLines.entrySet()) {
-            String value = (String) opt.getValue();
+            String value = String.valueOf(opt.getValue());
             switch (opt.getKey().toLowerCase()) {
                 case "server" -> setServer(value);
                 case "port" -> setPort(Integer.parseInt(value));
@@ -70,7 +70,11 @@ public DolphinConfig mergeCommandOptions(Map<String, Object> commandLines) {
     }
 
     public Locale getLanguage() {
-        return switch (this.language.toLowerCase()) {
+        return getLanguage(this.language);
+    }
+
+    public static Locale getLanguage(String locale){
+        return switch (locale) {
             case "zh" -> Locale.CHINESE;
             default -> Locale.ENGLISH;
         };

src/main/java/org/angellock/impl/DolphinConfig.java

@@ -60,14 +60,14 @@ public boolean canSendMessages() {
 
     @Override
     public void onJoin() {
-        log.info(TranslatableUtil.getFormattedMessage(EnumSystemEvents.SERVER_CONNECTION_ESTABLISHED, this.getProfileName()));
+        log.info(this.getBotLabel(), TranslatableUtil.getFormattedMessage(EnumSystemEvents.SERVER_CONNECTION_ESTABLISHED, this.getProfileName()));
     }
 
     @Override
     public void onQuit(String reason) {
         long millis = System.currentTimeMillis() - this.connectTime;
-        log.info(ConsoleTokens.colorizeText("[{}] &7Session Duration: &f{}ms"), this.getProfileName(), millis);
-        TranslatableUtil.infoTranslatableOf(EnumSystemEvents.DISCONNECT, reason);
+        log.info(this.getBotLabel(), ConsoleTokens.colorizeText("[{}] &7Session Duration: &f{}ms"), this.getProfileName(), millis);
+        log.info(TranslatableUtil.getFormattedMessage(EnumSystemEvents.DISCONNECT, reason));
         this.getPluginManager().disableAllPlugins(this);
         this.getSession().getChannel().close();
         this.getSession().getChannel().deregister();
@@ -87,7 +87,7 @@ public void onKicked() {
     @Override
     public void onPreLogin() {
         this.connectTime = System.currentTimeMillis();
-        TranslatableUtil.infoTranslatableOf(EnumSystemEvents.CONNECT, this.config().getServer(), String.valueOf(this.config().getPort()));
+        log.info(TranslatableUtil.getFormattedMessage(EnumSystemEvents.CONNECT, this.config().getServer(), this.config().getPort()));
     }
 
     @Override

src/main/java/org/angellock/impl/RobotPlayer.java

@@ -20,6 +20,8 @@
 import joptsimple.NonOptionArgumentSpec;
 import joptsimple.OptionParser;
 import joptsimple.OptionSet;
+import lombok.Getter;
+import org.angellock.impl.api.HttpAPIServer;
 import org.angellock.impl.dolphin.GUIWindowManager;
 import org.angellock.impl.managers.BotManager;
 import org.angellock.impl.managers.ConfigManager;
@@ -46,6 +48,8 @@ public class Start {
     private static volatile boolean exit = false;
     private static final boolean win32 = System.getProperty("os.name").toLowerCase().contains("windows");
     private static GUIWindowManager guiManager;
+    @Getter
+    private static OptionSet GLOBAL_CONFIG;
     public static void main(String[] args) {
         OptionParser optionParser = new OptionParser();
 
@@ -59,19 +63,21 @@ public static void main(String[] args) {
         optionParser.accepts("port").withRequiredArg().ofType(String.class);
         optionParser.accepts("skin-recorder").withRequiredArg().ofType(String.class);
         optionParser.accepts("gui");
+        optionParser.accepts("api").withOptionalArg().ofType(Integer.class).defaultsTo(25560);
         ArgumentAcceptingOptionSpec<String> profilesArg = optionParser.accepts("profiles").withOptionalArg().ofType(String.class);
         ArgumentAcceptingOptionSpec<String> pluginDir = optionParser.accepts("plugin-dir").withOptionalArg().ofType(String.class);
         ArgumentAcceptingOptionSpec<String> configFile = optionParser.accepts("config-file").withOptionalArg().ofType(String.class);
         NonOptionArgumentSpec<String> unrecognizedOptions = optionParser.nonOptions();
-        OptionSet parsedOption = optionParser.parse(args);
+        GLOBAL_CONFIG = optionParser.parse(args);
 
-        List<?> badOptions = parsedOption.valuesOf(unrecognizedOptions);
+
+        List<?> badOptions = GLOBAL_CONFIG.valuesOf(unrecognizedOptions);
         if (!badOptions.isEmpty()){
             log.warn(ConsoleTokens.colorizeText("&6Omitted option arguments " + badOptions));
         }
 
         String defaultConfigPath = Optional
-                .ofNullable(parsedOption.valueOf(configFile))
+                .ofNullable(GLOBAL_CONFIG.valueOf(configFile))
                 .orElse("not-set");
 
         if (Files.exists(Paths.get(defaultConfigPath))) {
@@ -80,17 +86,25 @@ public static void main(String[] args) {
             log.error(ConsoleTokens.colorizeText("&4The specified config file path is invalid: " + defaultConfigPath));
             defaultConfigPath = null;
         }
-        @Nullable String profiles = (parsedOption.valueOf(profilesArg));
+        @Nullable String profiles = (GLOBAL_CONFIG.valueOf(profilesArg));
 
-        ConfigManager config = new ConfigManager(parsedOption, defaultConfigPath);
+        ConfigManager config = new ConfigManager(GLOBAL_CONFIG, defaultConfigPath);
         BotManager botManager = new BotManager(defaultConfigPath, ".json", config)
-                .globalPluginManager(parsedOption.valueOf(pluginDir))
+                .globalPluginManager(GLOBAL_CONFIG.valueOf(pluginDir))
                 .loadProfiles(profiles);
 
         Map<String, RobotPlayer> bots = BotManager.bots();
         getTerminal(bots.values().iterator().next());
 
-        if (parsedOption.has("gui")){
+        // Start HTTP API Server
+        int apiPort = (int) GLOBAL_CONFIG.valueOf("api");
+        try {
+            new HttpAPIServer(apiPort);
+        } catch (Exception e) {
+            log.error("Failed to start HTTP API Server on port " + apiPort, e);
+        }
+
+        if (GLOBAL_CONFIG.has("gui")){
             guiManager = new GUIWindowManager(botManager);
             guiManager.startGUI();
         } else {

src/main/java/org/angellock/impl/Start.java

@@ -0,0 +1,91 @@
+/*
+ * DolphinBot - https://github.com/NeonAngelThreads/DolphinBot
+ * Copyright (C) 2025 NeonAngelThreads (https://github.com/NeonAngelThreads)
+ *
+ *    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 <https://www.gnu.org/licenses/>.
+ *
+ * https://space.bilibili.com/386644641
+ */
+
+package org.angellock.impl.api;
+
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import com.sun.net.httpserver.HttpExchange;
+import com.sun.net.httpserver.HttpHandler;
+import com.sun.net.httpserver.HttpServer;
+import lombok.Getter;
+import lombok.extern.slf4j.Slf4j;
+import org.angellock.impl.RobotPlayer;
+import org.angellock.impl.api.websocket.LogWebSocketHandler;
+import org.angellock.impl.api.websocket.handlers.*;
+import org.angellock.impl.managers.BotManager;
+import org.angellock.impl.util.ConsoleTokens;
+import org.angellock.impl.util.reason.KickReason;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.io.OutputStream;
+import java.net.InetSocketAddress;
+import java.nio.charset.StandardCharsets;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.Executors;
+
+@Slf4j
+public class HttpAPIServer {
+    @Getter
+    private static HttpAPIServer instance;
+    private final HttpServer server;
+    private final LogWebSocketHandler logWebSocketServer;
+    private final int wsPort;
+
+    public HttpAPIServer(int port) throws IOException {
+        instance = this;
+        this.wsPort = port + 1;
+        this.server = HttpServer.create(new InetSocketAddress(port), 0);
+        this.server.setExecutor(Executors.newCachedThreadPool());
+
+        registerRoutes();
+
+        // 启动日志WebSocket服务
+        this.logWebSocketServer = new LogWebSocketHandler(wsPort);
+        this.logWebSocketServer.start();
+
+        this.server.start();
+        log.info(ConsoleTokens.colorizeText("&aHTTP API Server started on port &b{}&a, ready to accept requests"), port);
+        log.info(ConsoleTokens.colorizeText("&aLog WebSocket Server started on port &b{}&a"), wsPort);
+    }
+
+    private void registerRoutes() {
+        server.createContext("/api/health", new HeartBeatHandler());
+        server.createContext("/api/bots", new BotsHandler("GET"));
+        server.createContext("/api/bots/start", new BotStartHandler("POST"));
+        server.createContext("/api/bots/stop", new BotStopHandler("POST"));
+        server.createContext("/api/bots/send-command", new CommandHandler("POST"));
+        server.createContext("/api/config", new ConfigHandler());
+        server.createContext("/api/bot/create", new AddedBotHandler("POST"));
+    }
+
+    public void stop() {
+        server.stop(0);
+        try {
+            logWebSocketServer.stop();
+        } catch (InterruptedException e) {
+            log.error("Failed to stop WebSocket server", e);
+        }
+        log.info(ConsoleTokens.colorizeText("&eHTTP API Server stopped"));
+        log.info(ConsoleTokens.colorizeText("&eLog WebSocket Server stopped"));
+    }
+}

src/main/java/org/angellock/impl/api/HttpAPIServer.java

@@ -0,0 +1,64 @@
+/*
+ * DolphinBot - https://github.com/NeonAngelThreads/DolphinBot
+ * Copyright (C) 2025 NeonAngelThreads (https://github.com/NeonAngelThreads)
+ *
+ *    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 <https://www.gnu.org/licenses/>.
+ *
+ * https://space.bilibili.com/386644641
+ */
+
+package org.angellock.impl.api;
+
+import ch.qos.logback.classic.spi.ILoggingEvent;
+import ch.qos.logback.core.AppenderBase;
+import ch.qos.logback.core.encoder.Encoder;
+import lombok.Getter;
+import lombok.Setter;
+
+import java.nio.charset.StandardCharsets;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.function.BiConsumer;
+import java.util.function.Consumer;
+
+@Setter
+@Getter
+public class WebLogAppender extends AppenderBase<ILoggingEvent> {
+    private Encoder<ILoggingEvent> encoder;
+    private static final List<BiConsumer<String, String>> logListeners = new ArrayList<>();
+
+    @Override
+    protected void append(ILoggingEvent eventObject) {
+        if (!isStarted() || logListeners.isEmpty()) {
+            return;
+        }
+
+        String botName = eventObject.getMarkerList().get(0).getName();
+        byte[] byteArray = this.encoder.encode(eventObject);
+        String message = new String(byteArray, StandardCharsets.UTF_8);
+
+        // 广播日志到所有监听器
+        for (BiConsumer<String, String> listener : logListeners) {
+            try {
+                listener.accept(message, botName);
+            } catch (Exception ignore) {
+            }
+        }
+    }
+
+    public static void addLogListener(BiConsumer<String, String> listener) {
+        logListeners.add(listener);
+    }
+
+    public static void removeLogListener(BiConsumer<String, String> listener) {
+        logListeners.remove(listener);
+    }
+
+}