Change the way message replies are handled

SO Chat now lets you specify the parent ID of the message you are
replying to in the HTTP POST parameters. This is what happens when you
click "reply". Previously, the ID had to be
specified at the beginning of the chat message. Monospace-formatted
replies render properly when using the parameter.

Author: mangstadt

src/main/java/oakbot/bot/Bot.java

@@ -271,11 +271,11 @@ private void sendMessage(IRoom room, PostMessage message) throws IOException {
 		logger.atInfo().log(() -> "Sending message [room=" + room.getRoomId() + "]: " + filteredMessage);
 
 		synchronized (postedMessages) {
-			var messageIds = room.sendMessage(filteredMessage, message.splitStrategy());
+			var messageIds = room.sendMessage(filteredMessage, message.parentId(), message.splitStrategy());
 			var condensedMessage = message.condensedMessage();
 			var ephemeral = message.ephemeral();
 
-			var postedMessage = new PostedMessage(Instant.now(), filteredMessage, condensedMessage, ephemeral, room.getRoomId(), messageIds);
+			var postedMessage = new PostedMessage(Instant.now(), filteredMessage, condensedMessage, ephemeral, room.getRoomId(), message.parentId(), messageIds);
 			postedMessages.put(messageIds.get(0), postedMessage);
 		}
 	}
@@ -486,6 +486,7 @@ private static class PostedMessage {
 		private final String condensedContent;
 		private final boolean ephemeral;
 		private final int roomId;
+		private final long parentId;
 		private final List<Long> messageIds;
 
 		/**
@@ -498,16 +499,18 @@ private static class PostedMessage {
 		 * @param ephemeral true to delete the message after the amount of time
 		 * specified in the "hideOneboxesAfter" setting, false not to
 		 * @param roomId the ID of the room the message was posted in
+		 * @param parentId the ID of the message that this was a reply to
 		 * @param messageIds the ID of each message that was actually posted to
 		 * the room (the chat client may split up the original message due to
 		 * length limitations)
 		 */
-		public PostedMessage(Instant timePosted, String originalContent, String condensedContent, boolean ephemeral, int roomId, List<Long> messageIds) {
+		public PostedMessage(Instant timePosted, String originalContent, String condensedContent, boolean ephemeral, int roomId, long parentId, List<Long> messageIds) {
 			this.timePosted = timePosted;
 			this.originalContent = originalContent;
 			this.condensedContent = condensedContent;
 			this.ephemeral = ephemeral;
 			this.roomId = roomId;
+			this.parentId = parentId;
 			this.messageIds = messageIds;
 		}
 
@@ -575,6 +578,14 @@ public boolean isCondensableOrEphemeral() {
 		public boolean isEphemeral() {
 			return ephemeral;
 		}
+		
+		/**
+		 * Gets the ID of the message that this was a reply to.
+		 * @return the parent ID or 0 if it's not a reply
+		 */
+		public long getParentId() {
+			return parentId;
+		}
 	}
 
 	private abstract class Chore implements Comparable<Chore> {
@@ -945,7 +956,7 @@ public void complete() {
 
 					var messageIds = postedMessage.getMessageIds();
 					var quotedContent = quote(condensedContent);
-					room.editMessage(messageIds.get(0), quotedContent);
+					room.editMessage(messageIds.get(0), postedMessage.getParentId(), quotedContent);
 
 					/*
 					 * If the original content was split up into
@@ -963,6 +974,7 @@ public void complete() {
 			}
 		}
 
+		@SuppressWarnings("deprecation")
 		private String quote(String content) {
 			var cb = new ChatBuilder();
 

src/main/java/oakbot/bot/ChatActions.java

@@ -5,6 +5,7 @@
 import java.util.List;
 
 import com.github.mangstadt.sochat4j.ChatMessage;
+import com.github.mangstadt.sochat4j.SplitStrategy;
 
 import oakbot.util.ChatBuilder;
 
@@ -53,11 +54,11 @@ public static ChatActions post(CharSequence message) {
 	 * @param parent the message to reply to
 	 * @return the created object
 	 */
-	public static ChatActions reply(String message, ChatMessage parent) {
+	public static ChatActions reply(CharSequence message, long parentId) {
 		//@formatter:off
-		return post(new ChatBuilder()
-			.reply(parent)
-			.append(message)
+		return ChatActions.create(
+			new PostMessage(message)
+				.parentId(parentId)
 		);
 		//@formatter:on
 	}
@@ -69,10 +70,39 @@ public static ChatActions reply(String message, ChatMessage parent) {
 	 * @param parent the message to reply to
 	 * @return the created object
 	 */
-	public static ChatActions reply(String message, ChatCommand parent) {
+	public static ChatActions reply(CharSequence message, ChatMessage parent) {
+		return reply(message, parent.getMessageId());
+	}
+
+	/**
+	 * Convenience method for creating a list with a single
+	 * {@link PostMessage} action that is a reply to a chat message.
+	 * @param message the message to post
+	 * @param parent the message to reply to
+	 * @return the created object
+	 */
+	public static ChatActions reply(CharSequence message, ChatCommand parent) {
 		return reply(message, parent.getMessage());
 	}
 
+	/**
+	 * Convenience method for creating a list with a single
+	 * {@link PostMessage} action that is a reply to a chat message.
+	 * @param message the message to post
+	 * @param parent the message to reply to
+	 * @param splitStrategy the split strategy
+	 * @return the created object
+	 */
+	public static ChatActions reply(CharSequence message, ChatCommand parent, SplitStrategy splitStrategy) {
+		//@formatter:off
+		return ChatActions.create(
+			new PostMessage(message)
+				.parentId(parent.getMessage().getMessageId())
+				.splitStrategy(splitStrategy)
+		);
+		//@formatter:on
+	}
+
 	/**
 	 * Convenience method for creating a list with a single {@link PostMessage}
 	 * action that is a reply to a chat message and that contains an exception
@@ -84,10 +114,9 @@ public static ChatActions reply(String message, ChatCommand parent) {
 	 */
 	public static ChatActions error(CharSequence message, Exception exception, ChatCommand parent) {
 		//@formatter:off
-		return post(new ChatBuilder()
-			.reply(parent)
+		return reply(new ChatBuilder()
 			.append(message)
-			.code(exception.getMessage())
+			.code(exception.getMessage()), parent
 		);
 		//@formatter:on
 	}

src/main/java/oakbot/bot/PostMessage.java

@@ -12,6 +12,7 @@
 public class PostMessage implements ChatAction {
 	private String message;
 	private String condensedMessage;
+	private long parentId;
 	private SplitStrategy splitStrategy = SplitStrategy.NONE;
 	private boolean bypassFilters;
 	private boolean ephemeral;
@@ -76,6 +77,24 @@ public PostMessage condensedMessage(CharSequence condensedMessage) {
 		return this;
 	}
 
+	/**
+	 * Gets the ID of the message that is being replied to.
+	 * @return the parent ID or 0 if not set
+	 */
+	public long parentId() {
+		return parentId;
+	}
+
+	/**
+	 * Sets the ID of the message that is being replied to.
+	 * @param parentId the parent ID
+	 * @return this
+	 */
+	public PostMessage parentId(long parentId) {
+		this.parentId = parentId;
+		return this;
+	}
+
 	/**
 	 * Determines how the message should be split up if it exceeds length
 	 * limitations. By default, the message will be truncated.
@@ -181,20 +200,20 @@ public Duration delay() {
 
 	@Override
 	public int hashCode() {
-		return Objects.hash(broadcast, bypassFilters, condensedMessage, delay, ephemeral, message, splitStrategy);
+		return Objects.hash(broadcast, bypassFilters, condensedMessage, delay, ephemeral, message, parentId, splitStrategy);
 	}
 
 	@Override
 	public boolean equals(Object obj) {
 		if (this == obj) return true;
 		if (obj == null) return false;
 		if (getClass() != obj.getClass()) return false;
-		var other = (PostMessage) obj;
-		return broadcast == other.broadcast && bypassFilters == other.bypassFilters && Objects.equals(condensedMessage, other.condensedMessage) && Objects.equals(delay, other.delay) && ephemeral == other.ephemeral && Objects.equals(message, other.message) && splitStrategy == other.splitStrategy;
+		PostMessage other = (PostMessage) obj;
+		return broadcast == other.broadcast && bypassFilters == other.bypassFilters && Objects.equals(condensedMessage, other.condensedMessage) && Objects.equals(delay, other.delay) && ephemeral == other.ephemeral && Objects.equals(message, other.message) && parentId == other.parentId && splitStrategy == other.splitStrategy;
 	}
 
 	@Override
 	public String toString() {
-		return "PostMessage [message=" + message + ", condensedMessage=" + condensedMessage + ", splitStrategy=" + splitStrategy + ", bypassFilters=" + bypassFilters + ", ephemeral=" + ephemeral + ", broadcast=" + broadcast + ", delay=" + delay + "]";
+		return "PostMessage [message=" + message + ", condensedMessage=" + condensedMessage + ", parentId=" + parentId + ", splitStrategy=" + splitStrategy + ", bypassFilters=" + bypassFilters + ", ephemeral=" + ephemeral + ", broadcast=" + broadcast + ", delay=" + delay + "]";
 	}
 }

src/main/java/oakbot/chat/mock/FileChatRoom.java

@@ -160,12 +160,7 @@ public List<ChatMessage> getMessages(int count) {
 	}
 
 	@Override
-	public long sendMessage(String message) {
-		return sendMessage(message, null).get(0);
-	}
-
-	@Override
-	public List<Long> sendMessage(String message, SplitStrategy splitStragey) {
+	public List<Long> sendMessage(String message, long parentId, SplitStrategy splitStragey) {
 		var id = postMessage(botUserId, botUsername, message);
 		return List.of(id);
 	}
@@ -218,7 +213,7 @@ public void deleteMessage(long messageId) throws RoomNotFoundException, RoomPerm
 	}
 
 	@Override
-	public void editMessage(long messageId, String updatedMessage) throws RoomNotFoundException, RoomPermissionException, IOException {
+	public void editMessage(long messageId, long parentId, String updatedMessage) throws RoomNotFoundException, RoomPermissionException, IOException {
 		System.out.println(roomId + " > " + botUsername + " > (edited message " + messageId + "): " + updatedMessage);
 	}
 

src/main/java/oakbot/command/AfkCommand.java

@@ -1,7 +1,6 @@
 package oakbot.command;
 
 import static oakbot.bot.ChatActions.doNothing;
-import static oakbot.bot.ChatActions.post;
 import static oakbot.bot.ChatActions.reply;
 
 import java.time.Duration;
@@ -82,7 +81,6 @@ public ChatActions onMessage(ChatMessage message, IBot bot) {
 		var usersNotWarnedAbout = filterUsersNotWarnedAbout(mentionedAfkUsers, message.getUserId());
 		if (!usersNotWarnedAbout.isEmpty()) {
 			var cb = new ChatBuilder();
-			cb.reply(message);
 			var first = true;
 			usersNotWarnedAbout.sort(Comparator.comparing(AfkUser::getUsername));
 			for (var afkUser : usersNotWarnedAbout) {
@@ -100,7 +98,7 @@ public ChatActions onMessage(ChatMessage message, IBot bot) {
 
 				first = false;
 			}
-			return post(cb);
+			return reply(cb, message);
 		}
 
 		if (returned) {

src/main/java/oakbot/command/DeleteCommand.java

@@ -2,7 +2,6 @@
 
 import static oakbot.bot.ChatActions.create;
 import static oakbot.bot.ChatActions.doNothing;
-import static oakbot.bot.ChatActions.post;
 import static oakbot.bot.ChatActions.reply;
 
 import java.util.List;
@@ -111,10 +110,9 @@ public ChatActions onMessage(ChatMessage message, IBot bot) {
 	private ChatActions deleteAction(long messageToDelete, long messageToReplyToOnError) {
 		//@formatter:off
 		return create(new DeleteMessage(messageToDelete).onError(e ->
-			post(new ChatBuilder()
-				.reply(messageToReplyToOnError)
+			reply(new ChatBuilder()
 				.append("Unable to delete message: ")
-				.code(e.getMessage())
+				.code(e.getMessage()), messageToReplyToOnError
 			)
 		));
 		//@formatter:on

src/main/java/oakbot/command/FatCatCommand.java

@@ -128,7 +128,6 @@ private ChatActions addCat(ChatCommand chatCommand, IBot bot, String cat) {
 		if (cat == null) {
 			//@formatter:off
 			return post(new ChatBuilder()
-				.reply(chatCommand)
 				.append("Specify the URL of the cat you want to add: ")
 				.code()
 				.append(bot.getTrigger())
@@ -163,14 +162,13 @@ private ChatActions deleteCat(ChatCommand chatCommand, IBot bot, String cat) {
 
 		if (cat == null) {
 			//@formatter:off
-			return post(new ChatBuilder()
-				.reply(chatCommand)
+			return reply(new ChatBuilder()
 				.append("Specify the URL of the cat you want to delete: ")
 				.code()
 				.append(bot.getTrigger())
 				.append(name())
 				.append(" delete URL")
-				.code()
+				.code(), chatCommand
 			);
 			//@formatter:on
 		}

src/main/java/oakbot/command/HelpCommand.java

@@ -264,15 +264,10 @@ private ChatActions showHelpText(ChatCommand message, String trigger) {
 		}
 
 		var cb = new ChatBuilder();
-		cb.reply(message);
 		for (var helpText : helpTexts) {
 			cb.append(helpText).nl();
 		}
 
-		//@formatter:off
-		return ChatActions.create(
-			new PostMessage(cb.toString().trim()).splitStrategy(SplitStrategy.NEWLINE)
-		);
-		//@formatter:on
+		return reply(cb.toString().trim(), message, SplitStrategy.NEWLINE);
 	}
 }

src/main/java/oakbot/command/RemindCommand.java

@@ -52,7 +52,7 @@ public ChatActions onMessage(ChatCommand chatCommand, IBot bot) {
 
 		//@formatter:off
 		return ChatActions.create(
-			new PostMessage(new ChatBuilder().reply(chatCommand).append("Created.")),
+			new PostMessage(new ChatBuilder().append("Created.")).parentId(chatCommand.getMessage().getMessageId()),
 			new PostMessage(new ChatBuilder().mention(mention).append(" ").append(reminder)).delay(duration)
 		);
 		//@formatter:on

src/main/java/oakbot/command/RollCommand.java

@@ -1,6 +1,5 @@
 package oakbot.command;
 
-import static oakbot.bot.ChatActions.post;
 import static oakbot.bot.ChatActions.reply;
 
 import java.util.Arrays;
@@ -52,9 +51,8 @@ public ChatActions onMessage(ChatCommand chatCommand, IBot bot) {
 
 		if (parameters.times <= 0) {
 			//@formatter:off
-			return post(new ChatBuilder()
-				.reply(chatCommand)
-				.italic("rolls nothing")
+			return reply(new ChatBuilder()
+				.italic("rolls nothing"), chatCommand
 			);
 			//@formatter:on
 		}
@@ -70,7 +68,6 @@ public ChatActions onMessage(ChatCommand chatCommand, IBot bot) {
 		//@formatter:on
 
 		var cb = new ChatBuilder();
-		cb.reply(chatCommand);
 
 		//@formatter:off
 		cb.append(Arrays.stream(results)
@@ -85,7 +82,7 @@ public ChatActions onMessage(ChatCommand chatCommand, IBot bot) {
 			cb.nl().append("Average = ").append(Double.toString(average));
 		}
 
-		return post(cb);
+		return reply(cb, chatCommand);
 	}
 
 	private Parameters parseParameters(ChatCommand chatCommand) {