feat: Chat history on join (#59)

ryanwohara · web-flow · commit 5943c9f1598c · 2026-04-15T13:23:24.000-06:00
* feat: IRCv3 chat history

* chore: Update to latest example plugin

* fix: CAP has = in it
diff --git a/build.gradle b/build.gradle
@@ -2,20 +2,19 @@ plugins {
 	id 'java'
 }
 
-java {
-	sourceCompatibility = JavaVersion.VERSION_11
-	targetCompatibility = JavaVersion.VERSION_11
-}
-
 repositories {
 	mavenLocal()
 	maven {
 		url = 'https://repo.runelite.net'
+		content {
+			includeGroupByRegex("net\\.runelite.*")
+		}
 	}
 	mavenCentral()
 }
 
 def runeLiteVersion = 'latest.release'
+def pluginMainClass = 'com.irc.IrcPlugin'
 
 dependencies {
 	compileOnly group: 'net.runelite', name:'client', version: runeLiteVersion
@@ -28,14 +27,44 @@ dependencies {
 	testImplementation group: 'net.runelite', name:'jshell', version: runeLiteVersion
 }
 
-tasks.withType(AbstractArchiveTask).configureEach {
-	duplicatesStrategy = DuplicatesStrategy.EXCLUDE
+group = 'com.irc'
+version = '2.1'
+
+tasks.withType(JavaCompile).configureEach {
+	options.encoding = 'UTF-8'
+	options.release.set(11)
 }
 
-group = 'com.example'
-version = '1.0-SNAPSHOT'
-sourceCompatibility = '1.11'
+tasks.register('run', JavaExec) {
+	classpath = sourceSets.test.runtimeClasspath
+	mainClass = pluginMainClass
 
-tasks.withType(JavaCompile) {
-	options.encoding = 'UTF-8'
+	jvmArgs "-ea"
+	args "--developer-mode", "--debug"
 }
+
+tasks.register('shadowJar', Jar) {
+	dependsOn configurations.testRuntimeClasspath
+	manifest {
+		attributes('Main-Class': pluginMainClass, 'Multi-Release': true)
+	}
+
+	duplicatesStrategy = DuplicatesStrategy.EXCLUDE
+	from sourceSets.main.output
+	from sourceSets.test.output
+	from {
+		configurations.testRuntimeClasspath.collect { file ->
+			file.isDirectory() ? file : zipTree(file)
+		}
+	}
+
+	exclude 'META-INF/INDEX.LIST'
+	exclude 'META-INF/*.SF'
+	exclude 'META-INF/*.DSA'
+	exclude 'META-INF/*.RSA'
+	exclude '**/module-info.class'
+
+	group = BasePlugin.BUILD_GROUP
+	archiveClassifier.set('shadow')
+	archiveFileName.set("${rootProject.name}-${project.version}-all.jar")
+}
diff --git a/src/main/java/com/irc/IrcAdapter.java b/src/main/java/com/irc/IrcAdapter.java
@@ -340,6 +340,34 @@ private void setupEventHandlers() {
                 case TOPIC_INFO:
                     processMessage(new IrcMessage(event.getTarget(), event.getSource(), event.getMessage(), IrcMessage.MessageType.TOPIC, Instant.now()));
                     break;
+
+                case HISTORY_BATCH:
+                    if (event.getHistoryMessages() != null && !event.getHistoryMessages().isEmpty()) {
+                        for (SimpleIrcClient.IrcEvent accEvent : event.getHistoryMessages()) {
+                            Instant timestamp;
+                            try {
+                                String timeStr = accEvent.getAdditionalData();
+                                timestamp = (timeStr != null && !timeStr.isEmpty())
+                                    ? Instant.parse(timeStr)
+                                    : Instant.now();
+                            } catch (Exception e) {
+                                timestamp = Instant.now();
+                            }
+                            String sender = accEvent.getSource() != null ? accEvent.getSource() : "";
+                            if (accEvent.getType() == SimpleIrcClient.IrcEvent.Type.ACTION) {
+                                sender = "* " + sender;
+                            }
+                            processMessage(new IrcMessage(
+                                event.getTarget(), sender, accEvent.getMessage(),
+                                IrcMessage.MessageType.HISTORY, timestamp
+                            ));
+                        }
+                        processMessage(new IrcMessage(
+                            event.getTarget(), "*", "--- Begin of chat ---",
+                            IrcMessage.MessageType.HISTORY_SEPARATOR, Instant.now()
+                        ));
+                    }
+                    break;
             }
         });
     }
diff --git a/src/main/java/com/irc/IrcMessage.java b/src/main/java/com/irc/IrcMessage.java
@@ -12,6 +12,7 @@ public class IrcMessage {
     Instant timestamp;
 
     enum MessageType {
-        CHAT, SYSTEM, JOIN, PART, QUIT, NICK_CHANGE, PRIVATE, NOTICE, KICK, TOPIC, MODE
+        CHAT, SYSTEM, JOIN, PART, QUIT, NICK_CHANGE, PRIVATE, NOTICE, KICK, TOPIC, MODE,
+        HISTORY, HISTORY_SEPARATOR
     }
 }
diff --git a/src/main/java/com/irc/IrcPanel.java b/src/main/java/com/irc/IrcPanel.java
@@ -518,6 +518,9 @@ void appendMessage(IrcMessage message, IrcConfig config) {
         }
 
         private String formatPanelMessage(IrcMessage message, IrcConfig config) {
+            if (message.getType() == IrcMessage.MessageType.HISTORY_SEPARATOR) {
+                return "<div style='color: #808080; text-align: center;'>--- Begin of chat ---</div>";
+            }
             DateTimeFormatter formatter = DateTimeFormatter.ofPattern("HH:mm:ss").withZone(ZoneId.systemDefault());
             String timeStamp = "";
             if (config.timestamp()) {
diff --git a/src/main/java/com/irc/SimpleIrcClient.java b/src/main/java/com/irc/SimpleIrcClient.java
@@ -52,6 +52,16 @@ public class SimpleIrcClient {
     private boolean connected = false;
     private volatile boolean shuttingDown = false;
 
+    String currentTagTime;   // package-private: accessed by TestableIrcClient subclass
+    String currentTagBatch;  // package-private: accessed by TestableIrcClient subclass
+
+    private final Map<String, List<IrcEvent>> activeBatches = new HashMap<>();
+    private final Map<String, String> activeBatchChannels = new HashMap<>();
+
+    boolean capHistorySupported = false;  // package-private: accessed by TestableIrcClient subclass
+    private boolean capEndSent = false;
+    private final Set<String> advertisedCaps = new HashSet<>();
+
     public SimpleIrcClient server(String host, int port, boolean secure) {
         this.host = host;
         this.port = port;
@@ -86,8 +96,12 @@ public void connect() {
                 if (password != null && !password.isEmpty()) {
                     sendRawLine("PASS " + password);
                 }
+                advertisedCaps.clear();
+                capEndSent = false;
+                capHistorySupported = false;
                 sendRawLine("NICK " + nick);
                 sendRawLine("USER " + username + " 0 * :" + realName);
+                sendRawLine("CAP LS 302");
 
                 connected = true;
                 fireEvent(new IrcEvent(IrcEvent.Type.CONNECT, null, null, null, null));
@@ -153,6 +167,8 @@ public void disconnect(String reason) {
             } catch (IOException ignored) {
             }
         } finally {
+            activeBatches.clear();
+            activeBatchChannels.clear();
             connected = false;
             fireEvent(new IrcEvent(IrcEvent.Type.DISCONNECT, null, null, null, null));
         }
@@ -210,6 +226,10 @@ public void setNick(String newNick) {
         }
     }
 
+    void setNickDirect(String nick) {
+        this.nick = nick;
+    }
+
     public synchronized void sendRawLine(String line) {
         if (writer == null) return;
         try {
@@ -220,7 +240,29 @@ public synchronized void sendRawLine(String line) {
         }
     }
 
-    private void processLine(String line) {
+    void processLine(String line) {
+        // Reset per-line tag state
+        currentTagTime = null;
+        currentTagBatch = null;
+
+        // Strip and parse IRCv3 message tags (@key=value;...)
+        if (line.startsWith("@")) {
+            int spaceIdx = line.indexOf(' ');
+            if (spaceIdx > 0) {
+                String tagSegment = line.substring(1, spaceIdx);
+                line = line.substring(spaceIdx + 1);
+                for (String tag : tagSegment.split(";")) {
+                    int eq = tag.indexOf('=');
+                    if (eq > 0) {
+                        String key = tag.substring(0, eq);
+                        String value = tag.substring(eq + 1);
+                        if ("time".equals(key)) currentTagTime = value;
+                        else if ("batch".equals(key)) currentTagBatch = value;
+                    }
+                }
+            }
+        }
+
         Matcher matcher = MESSAGE_PATTERN.matcher(line);
 
         if (matcher.matches()) {
@@ -258,6 +300,33 @@ private void processLine(String line) {
     private void processCommand(String source, String command, List<String> params) {
         String sourceNick = extractNick(source);
 
+        // IRCv3 batch intercept: accumulate tagged messages instead of processing normally
+        if (currentTagBatch != null && activeBatches.containsKey(currentTagBatch)) {
+            String batchRef = currentTagBatch;
+            if (command.equalsIgnoreCase("PRIVMSG") && params.size() >= 2) {
+                String target = params.get(0);
+                String msgBody = params.get(1);
+                if (msgBody.startsWith("\u0001") && msgBody.endsWith("\u0001")) {
+                    // CTCP — check for ACTION
+                    String ctcp = msgBody.substring(1, msgBody.length() - 1);
+                    String[] parts = ctcp.split(" ", 2);
+                    if ("ACTION".equals(parts[0])) {
+                        String actionText = parts.length > 1 ? parts[1] : "";
+                        activeBatches.get(batchRef).add(
+                            new IrcEvent(IrcEvent.Type.ACTION, sourceNick, target, actionText, currentTagTime)
+                        );
+                    }
+                } else {
+                    activeBatches.get(batchRef).add(
+                        new IrcEvent(IrcEvent.Type.MESSAGE, sourceNick, target, msgBody, currentTagTime)
+                    );
+                }
+                return;
+            }
+            // Non-PRIVMSG commands in a chathistory batch are silently ignored
+            return;
+        }
+
         switch (command.toUpperCase()) {
             case "PRIVMSG":
                 if (params.size() >= 2) {
@@ -278,6 +347,9 @@ private void processCommand(String source, String command, List<String> params)
                     String channel = params.get(0);
                     fireEvent(new IrcEvent(IrcEvent.Type.JOIN, sourceNick, channel, null, null));
                     channelUsers.computeIfAbsent(channel, k -> new HashSet<>()).add(sourceNick);
+                    if (sourceNick.equals(nick) && capHistorySupported) {
+                        sendRawLine("CHATHISTORY LATEST " + channel + " * 100");
+                    }
                 }
                 break;
 
@@ -288,9 +360,11 @@ private void processCommand(String source, String command, List<String> params)
 
                     if (!sourceNick.equals(nick)) {
                         fireEvent(new IrcEvent(IrcEvent.Type.PART, sourceNick, channel, reason, null));
-                    }
-                    if (channelUsers.containsKey(channel)) {
-                        channelUsers.get(channel).remove(sourceNick);
+                        if (channelUsers.containsKey(channel)) {
+                            channelUsers.get(channel).remove(sourceNick);
+                        }
+                    } else {
+                        channelUsers.remove(channel);
                     }
                 }
                 break;
@@ -339,8 +413,12 @@ private void processCommand(String source, String command, List<String> params)
                     String kickMessage = params.size() > 2 ? params.get(2) : "";
 
                     fireEvent(new IrcEvent(IrcEvent.Type.KICK, sourceNick, channel, kickedUser + " " + kickMessage, null));
-                    if (channelUsers.containsKey(channel)) {
-                        channelUsers.get(channel).remove(kickedUser);
+                    if (!kickedUser.equals(nick)) {
+                        if (channelUsers.containsKey(channel)) {
+                            channelUsers.get(channel).remove(kickedUser);
+                        }
+                    } else {
+                        channelUsers.remove(channel);
                     }
                 }
                 break;
@@ -381,6 +459,77 @@ private void processCommand(String source, String command, List<String> params)
                 }
                 break;
 
+            case "BATCH":
+                if (params.isEmpty()) break;
+                String batchToken = params.get(0);
+                if (batchToken.startsWith("+")) {
+                    String ref = batchToken.substring(1);
+                    // params = [+ref, type, channel]
+                    String batchChannel = params.size() >= 3 ? params.get(2) : "";
+                    activeBatches.put(ref, new ArrayList<>());
+                    activeBatchChannels.put(ref, batchChannel);
+                } else if (batchToken.startsWith("-")) {
+                    String ref = batchToken.substring(1);
+                    List<IrcEvent> accumulated = activeBatches.remove(ref);
+                    String batchChannel = activeBatchChannels.remove(ref);
+                    if (accumulated != null && batchChannel != null) {
+                        fireEvent(new IrcEvent(IrcEvent.Type.HISTORY_BATCH, null, batchChannel, null, null, accumulated));
+                    }
+                }
+                break;
+
+            case "CAP":
+                if (params.size() < 2) break;
+                String capSubCommand = params.get(1).toUpperCase();
+                switch (capSubCommand) {
+                    case "LS": {
+                        // Check for multi-line continuation: params = [clientNick, LS, *, cap-list] vs [clientNick, LS, cap-list]
+                        boolean isContinuation = params.size() >= 4 && "*".equals(params.get(2));
+                        String capList = isContinuation ? params.get(3) : (params.size() >= 3 ? params.get(2) : "");
+                        for (String cap : capList.split(" ")) {
+                            if (!cap.isEmpty()) {
+                                int eq = cap.indexOf('=');
+                                advertisedCaps.add(eq > 0 ? cap.substring(0, eq) : cap);
+                            }
+                        }
+                        if (!isContinuation) {
+                            // Final LS line: decide what to request
+                            List<String> toRequest = new ArrayList<>();
+                            if (advertisedCaps.contains("chathistory")) toRequest.add("chathistory");
+                            if (advertisedCaps.contains("batch")) toRequest.add("batch");
+                            if (advertisedCaps.contains("server-time")) toRequest.add("server-time");
+                            if (!toRequest.isEmpty()) {
+                                sendRawLine("CAP REQ :" + String.join(" ", toRequest));
+                            } else if (!capEndSent) {
+                                sendRawLine("CAP END");
+                                capEndSent = true;
+                            }
+                        }
+                        break;
+                    }
+                    case "ACK": {
+                        String acked = params.size() >= 3 ? params.get(2) : "";
+                        for (String cap : acked.split(" ")) {
+                            if ("chathistory".equals(cap.trim())) {
+                                capHistorySupported = true;
+                            }
+                        }
+                        if (!capEndSent) {
+                            sendRawLine("CAP END");
+                            capEndSent = true;
+                        }
+                        break;
+                    }
+                    case "NAK":
+                        capHistorySupported = false;
+                        if (!capEndSent) {
+                            sendRawLine("CAP END");
+                            capEndSent = true;
+                        }
+                        break;
+                }
+                break;
+
             default:
                 if (NUMERIC.matcher(command).matches()) {
                     int numeric = Integer.parseInt(command);
@@ -533,21 +682,29 @@ public static class IrcEvent {
         public enum Type {
             CONNECT, DISCONNECT, REGISTERED, MESSAGE, ACTION, JOIN, PART, QUIT,
             NICK_CHANGE, KICK, NOTICE, SERVER_NOTICE, CHANNEL_MODE, USER_MODE,
-            TOPIC, NAMES, NICK_IN_USE, ERROR, TOPIC_INFO, BAD_CHANNEL_KEY, WHOIS_REPLY
+            TOPIC, NAMES, NICK_IN_USE, ERROR, TOPIC_INFO, BAD_CHANNEL_KEY, WHOIS_REPLY,
+            HISTORY_BATCH
         }
 
         private final Type type;
         private final String source;
         private final String target;
         private final String message;
         private final String additionalData;
+        private final List<IrcEvent> historyMessages;
 
-        public IrcEvent(Type type, String source, String target, String message, String additionalData) {
+        public IrcEvent(Type type, String source, String target, String message,
+                        String additionalData, List<IrcEvent> historyMessages) {
             this.type = type;
             this.source = source;
             this.target = target;
             this.message = message;
             this.additionalData = additionalData;
+            this.historyMessages = historyMessages;
+        }
+
+        public IrcEvent(Type type, String source, String target, String message, String additionalData) {
+            this(type, source, target, message, additionalData, null);
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ public class IrcMessage {`
`12`	`12`	`Instant timestamp;`
`13`	`13`
`14`	`14`	`enum MessageType {`
`15`		`- CHAT, SYSTEM, JOIN, PART, QUIT, NICK_CHANGE, PRIVATE, NOTICE, KICK, TOPIC, MODE`
	`15`	`+ CHAT, SYSTEM, JOIN, PART, QUIT, NICK_CHANGE, PRIVATE, NOTICE, KICK, TOPIC, MODE,`
	`16`	`+ HISTORY, HISTORY_SEPARATOR`
`16`	`17`	`}`
`17`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -518,6 +518,9 @@ void appendMessage(IrcMessage message, IrcConfig config) {`
`518`	`518`	`}`
`519`	`519`
`520`	`520`	`private String formatPanelMessage(IrcMessage message, IrcConfig config) {`
	`521`	`+ if (message.getType() == IrcMessage.MessageType.HISTORY_SEPARATOR) {`
	`522`	`+ return "<div style='color: #808080; text-align: center;'>--- Begin of chat ---</div>";`
	`523`	`+ }`
`521`	`524`	`DateTimeFormatter formatter = DateTimeFormatter.ofPattern("HH:mm:ss").withZone(ZoneId.systemDefault());`
`522`	`525`	`String timeStamp = "";`
`523`	`526`	`if (config.timestamp()) {`