Merge pull request #29 from ModdedMinecraftClub/feature/broadcasts

Feature/broadcasts - add broadcasts

Author: TraceLD

server/src/main/java/club/moddedminecraft/polychat/server/Broadcaster.java

@@ -0,0 +1,54 @@
+package club.moddedminecraft.polychat.server;
+
+import club.moddedminecraft.polychat.core.messagelibrary.ChatProtos;
+import club.moddedminecraft.polychat.core.networklibrary.Server;
+import com.google.protobuf.Any;
+
+import java.util.List;
+
+public final class Broadcaster {
+    private final String id;
+    private final String prefix;
+    private final List<String> broadcastMessages;
+    private final Server server;
+
+    private int broadcastsTimer;
+    private int broadcastMsgsIndex;
+
+    public static final int BROADCAST_EVERY_X_IN_TICKS = (10 * 60 * 20);
+
+    public Broadcaster(String broadcastID, String broadcastPrefix, List<String> broadcastMessages, Server server) {
+        this.id = broadcastID;
+        this.prefix = broadcastPrefix;
+        this.broadcastMessages = broadcastMessages;
+        this.server = server;
+
+        broadcastsTimer = 0;
+        broadcastMsgsIndex = 0;
+    }
+
+    public void tick() {
+        if (broadcastMessages.size() == 0) {
+            return;
+        }
+
+        if (broadcastsTimer == BROADCAST_EVERY_X_IN_TICKS) {
+            broadcast();
+            broadcastsTimer = 0;
+            broadcastMsgsIndex = (broadcastMsgsIndex + 1) % broadcastMessages.size();
+        } else {
+            broadcastsTimer += 1;
+        }
+    }
+
+    private void broadcast() {
+        String broadcastMsg = broadcastMessages.get(broadcastMsgsIndex);
+        ChatProtos.ChatMessage msg = ChatProtos.ChatMessage.newBuilder()
+                .setServerId(id)
+                .setMessage(prefix + " " + broadcastMsg)
+                .setMessageOffset(5)
+                .build();
+        Any any = Any.pack(msg);
+        server.broadcastMessageToAll(any.toByteArray());
+    }
+}

server/src/main/java/club/moddedminecraft/polychat/server/PolychatServer.java

@@ -25,19 +25,19 @@
 import java.io.IOException;
 import java.nio.file.Path;
 import java.nio.file.Paths;
-import java.util.HashMap;
+import java.util.*;
 import java.util.concurrent.ConcurrentLinkedDeque;
 
 public final class PolychatServer {
     private final ConcurrentLinkedDeque<GenericEvent> queue;
     private final Server server;
     private final PolychatProtobufMessageDispatcher polychatProtobufMessageDispatcher;
-    private final JDA jda;
     private final HashMap<String, OnlineServer> onlineServers;
-    private final TextChannel generalChannel;
     private final MessageReceivedHandler messageReceivedHandler;
+    private final Broadcaster broadcaster;
 
     private final static Logger logger = LoggerFactory.getLogger(PolychatServer.class);
+
     public static final int TICK_TIME_IN_MILLIS = 50;
 
     private PolychatServer() throws IOException, LoginException, InterruptedException {
@@ -47,13 +47,19 @@ private PolychatServer() throws IOException, LoginException, InterruptedExceptio
         // set up TCP;
         server = new Server(yamlConfig.get("tcpPort"), yamlConfig.get("bufferSize"));
 
+        // set up broadcasts
+        List<String> broadcastMessages = yamlConfig.getOrDefault("broadcastMsgs", new ArrayList<String>());
+        String broadcastID = yamlConfig.getOrDefault("broadcastID", "BROADCAST");
+        String broadcastPrefix = yamlConfig.getOrDefault("broadcastPrefix", "[System]");
+        broadcaster = new Broadcaster(broadcastID, broadcastPrefix, broadcastMessages, server);
+
         // set up JDA event queue & servers hashmap;
         queue = new ConcurrentLinkedDeque<GenericEvent>();
         onlineServers = new HashMap<>();
 
         // set up JDA commands;
         CommandClient commandClient = new CommandClientBuilder()
-                .setOwnerId(yamlConfig.get("ownerId")) // will need to be retrieved from YAML;
+                .setOwnerId(yamlConfig.get("ownerId"))
                 .setPrefix(yamlConfig.get("commandPrefix"))
                 .addCommands(
                         new ExecCommand(server, onlineServers),
@@ -64,14 +70,14 @@ private PolychatServer() throws IOException, LoginException, InterruptedExceptio
                 .build();
 
         // set up main JDA;
-        jda = JDABuilder.createDefault(yamlConfig.get("token")) // will need to be retrieved from YAML;
+        JDA jda = JDABuilder.createDefault(yamlConfig.get("token"))
                 .addEventListeners(
                         commandClient,
                         new GenericJdaEventHandler(queue)
                 )
                 .build()
                 .awaitReady();
-        generalChannel = jda.getTextChannelById(yamlConfig.get("generalChannelId")); // same as above here;
+        TextChannel generalChannel = jda.getTextChannelById(yamlConfig.get("generalChannelId"));
         messageReceivedHandler = new MessageReceivedHandler(generalChannel, server);
 
         // set up Protobuf message handlers;
@@ -87,37 +93,6 @@ private PolychatServer() throws IOException, LoginException, InterruptedExceptio
         );
     }
 
-    private YamlConfig getDefaultConfig(Path path) throws IOException {
-        YamlConfig def = YamlConfig.fromInMemoryString("");
-        def.set("token", "");
-        def.set("ownerId", "");
-        def.set("commandPrefix", "!");
-        def.set("generalChannelId", "");
-        def.set("tcpPort", 5005);
-        def.set("bufferSize", 4096);
-        def.saveToFile(path);
-        return def;
-    }
-
-    public YamlConfig getConfig() {
-        try {
-            Path configPath = Paths.get("polychat.yml");
-
-            if (configPath.toFile().createNewFile()) {
-                getDefaultConfig(configPath);
-                logger.error("You must have a config to use polychat! Creating default polychat.yml...");
-                System.exit(0);
-            }
-
-            return YamlConfig.fromFilesystem(configPath);
-        } catch (IOException e) {
-            logger.error("Failed to create a new config!");
-            e.printStackTrace();
-            System.exit(1);
-        }
-        return YamlConfig.fromInMemoryString("");
-    }
-
     public static void main(String[] args) {
         try {
             new PolychatServer().spin();
@@ -142,6 +117,8 @@ private void spin() {
     }
 
     private void spinOnce() {
+        broadcaster.tick();
+
         try {
             for (Message message : server.poll()) {
                 polychatProtobufMessageDispatcher.handlePolychatMessage(message);
@@ -158,4 +135,39 @@ private void spinOnce() {
             logger.error("Error occurred in Polychat server event loop", e);
         }
     }
+
+    private YamlConfig getDefaultConfig(Path path) throws IOException {
+        YamlConfig def = YamlConfig.fromInMemoryString("");
+        def.set("broadcastsPrefix", "");
+        def.set("token", "");
+        def.set("ownerId", "");
+        def.set("commandPrefix", "!");
+        def.set("generalChannelId", "");
+        def.set("tcpPort", 5005);
+        def.set("bufferSize", 4096);
+        def.set("broadcastMsgs", Arrays.asList("example broadcast message 1", "example broadcast message 2"));
+        def.set("broadcastID", "BROADCAST");
+        def.set("broadcastPrefix", "[System]");
+        def.saveToFile(path);
+        return def;
+    }
+
+    public YamlConfig getConfig() {
+        try {
+            Path configPath = Paths.get("polychat.yml");
+
+            if (configPath.toFile().createNewFile()) {
+                getDefaultConfig(configPath);
+                logger.error("You must have a config to use polychat! Creating default polychat.yml...");
+                System.exit(0);
+            }
+
+            return YamlConfig.fromFilesystem(configPath);
+        } catch (IOException e) {
+            logger.error("Failed to create a new config!");
+            e.printStackTrace();
+            System.exit(1);
+        }
+        return YamlConfig.fromInMemoryString("");
+    }
 }