models: add support for reactions

This commit adds support for reactions in the IRC client, and routes
them into the model. This commit does not yet allow for viewing
reactions, but it should store them correctly in the model for doing so.

This commit also fixes a bug where TAGMSGs (and other non-
PRIVMSG/NOTICE) commands were stored in the model. In the future maybe
this can be prevented by using a type-safe description of irc messages.

We allow PRIVMSG-based reacts, and assume that they are a fallback for
clients which do not support reactions. Thus we do not show the PRIVMSG,
only the reaction.

Author: 4e554c4c

lib/client_controller.dart

@@ -714,7 +714,6 @@ class ClientController {
 				if (typing != null && !client.isMyNick(msg.source.name)) {
 					_bufferList.get(target, network)?.setTyping(msg.source.name, typing == 'active');
 				}
-				break;
 			}
 			return _handleChatMessages(target, [msg]);
 		case 'INVITE':
@@ -801,6 +800,8 @@ class ClientController {
 				if (msg.cmd == 'NOTICE') {
 					notices.add(msg);
 					continue;
+				} else if (msg.cmd != 'PRIVMSG') {
+					continue;
 				}
 
 				// Disregard non-/me CTCP messages
@@ -843,16 +844,39 @@ class ClientController {
 			return;
 		}
 
-		var entries = messages.map((msg) => MessageEntry(msg, buf!.id)).toList();
-		await _db.storeMessages(entries);
+		List<MessageEntry> privmsgs = [];
+		List<ReactionEntry> reactions = [];
+		for (var msg in messages) {
+			var reply = msg.tags['+draft/reply'];
+			var react = msg.tags['+draft/react'];
+			if (reply != null && react != null) {
+				reactions.add(ReactionEntry(msg, buf.id));
+			} else if (msg.cmd == 'NOTICE' || msg.cmd == 'PRIVMSG') {
+				privmsgs.add(MessageEntry(msg, buf.id));
+			}
+		}
+
+		if (reactions.isNotEmpty) {
+			await _db.storeReactions(reactions);
+		}
+		if (privmsgs.isNotEmpty) {
+			await _db.storeMessages(privmsgs);
+		}
+
 		if (buf.messageHistoryLoaded) {
-			var models = await buildMessageModelList(_db, entries);
+			var models = await buildMessageModelList(_db, privmsgs);
 			buf.addMessages(models, append: !isHistory);
+			buf.addReactions(reactions);
+		}
+
+		// Only privmsgs affects unread count / lastReadTime
+		if (privmsgs.isEmpty) {
+			return;
 		}
 
-		String t = entries.first.time;
+		String t = privmsgs.first.time;
 		List<MessageEntry> unread = [];
-		for (var entry in entries) {
+		for (var entry in privmsgs) {
 			if (entry.time.compareTo(t) > 0) {
 				t = entry.time;
 			}
@@ -1194,27 +1218,29 @@ IrcUri? _uriFromBouncerNetworkModel(BouncerNetworkModel bouncerNetwork) {
 	);
 }
 
-Future<Iterable<MessageModel>> buildMessageModelList(DB db, List<MessageEntry> entries) async {
+Future<List<MessageModel>> buildMessageModelList(DB db, List<MessageEntry> entries) async {
 	if (entries.isEmpty) {
 		return [];
 	}
 
-	List<String> msgids = [];
+	List<String> parentMsgids = [];
 	for (var entry in entries) {
 		var parentMsgid = entry.msg.tags['+draft/reply'];
 		if (parentMsgid != null) {
-			msgids.add(parentMsgid);
+			parentMsgids.add(parentMsgid);
 		}
 	}
 
 	var bufferId = entries.first.buffer;
-	var parents = await db.fetchMessageSetByNetworkMsgid(bufferId, msgids);
+	var parentMap = await db.fetchMessageSetByNetworkMsgid(bufferId, parentMsgids);
+	var reactionMap = await db.fetchReactionSetBetweenMessages(bufferId, entries.first, entries.last);
 	return entries.map((entry) {
 		MessageEntry? replyTo;
 		var parentMsgid = entry.msg.tags['+draft/reply'];
 		if (parentMsgid != null) {
-			replyTo = parents[parentMsgid];
+			replyTo = parentMap[parentMsgid];
 		}
-		return MessageModel(entry: entry, replyTo: replyTo);
-	});
+		var reacts = reactionMap[entry.networkMsgid] ?? [];
+		return MessageModel(entry: entry, replyTo: replyTo, reactions: reacts);
+	}).toList();
 }

lib/models.dart

@@ -398,6 +398,7 @@ class BufferModel extends ChangeNotifier {
 	String? _lastDeliveredTime;
 	bool _messageHistoryLoaded = false;
 	List<MessageModel> _messages = [];
+	final Map<String, MessageModel> _messagesByNetworkMsgid = {};
 	final Map<String, Timer> _typing = {};
 
 	// Kept in sync by BufferPageState
@@ -497,18 +498,52 @@ class BufferModel extends ChangeNotifier {
 		notifyListeners();
 	}
 
-	void addMessages(Iterable<MessageModel> msgs, { bool append = false }) {
+	void _populateMessagesById(List<MessageModel> msgs) {
+		for (var msg in msgs) {
+			if (msg.entry.networkMsgid != null) {
+				_messagesByNetworkMsgid[msg.entry.networkMsgid!] = msg;
+			}
+		}
+	}
+
+	void _appendMessages(List<MessageModel> msgs) {
+		_messages.addAll(msgs);
+		_populateMessagesById(msgs);
+	}
+
+	void _prependMessages(List<MessageModel> msgs) {
+		assert(msgs.last.entry.time.compareTo(_messages.first.entry.time) <= 0);
+		_messages = [...msgs, ..._messages];
+		_populateMessagesById(msgs);
+	}
+
+	void addMessages(List<MessageModel> msgs, { bool append = false }) {
 		assert(messageHistoryLoaded);
 		if (msgs.isEmpty) {
 			return;
 		}
+
 		if (append) {
-			_messages.addAll(msgs);
+			_appendMessages(msgs);
 		} else {
 			// TODO: optimize this case
-			_messages.addAll(msgs);
+			_appendMessages(msgs);
 			_messages.sort(_compareMessageModels);
 		}
+
+		notifyListeners();
+	}
+
+	void addReactions(List<ReactionEntry> reacts) {
+		assert(messageHistoryLoaded);
+		if (reacts.isEmpty) {
+			return;
+		}
+
+		for (var reaction in reacts) {
+			_messagesByNetworkMsgid[reaction.replyNetworkMsgid]?._addReaction(reaction);
+		}
+
 		notifyListeners();
 	}
 
@@ -517,11 +552,10 @@ class BufferModel extends ChangeNotifier {
 		// must always come before the existing messages
 		if (!_messageHistoryLoaded) {
 			assert(_messages.isEmpty);
-			_messages = l;
+			_appendMessages(l);
 			_messageHistoryLoaded = true;
 		} else if (!l.isEmpty) {
-			assert(l.last.entry.time.compareTo(_messages.first.entry.time) <= 0);
-			_messages = [...l, ..._messages];
+			_prependMessages(l);
 		}
 		notifyListeners();
 	}
@@ -566,12 +600,25 @@ class MessageModel {
 	final MessageEntry entry;
 	final MessageEntry? replyTo;
 
-	MessageModel({ required this.entry, this.replyTo }) {
+	final List<ReactionEntry> _reactions;
+
+	MessageModel({
+		required this.entry,
+		this.replyTo,
+		Iterable<ReactionEntry>? reactions,
+	}) :
+		// Our reaction list needs to be mutable. This is why we spread
+		// instead of taking a list and storing it.
+		_reactions = [...?reactions],
 		assert(entry.id != null);
+
+	void _addReaction(ReactionEntry reaction) {
+		_reactions.add(reaction);
 	}
 
 	int get id => entry.id!;
 	IrcMessage get msg => entry.msg;
+	UnmodifiableListView<ReactionEntry> get reactions => UnmodifiableListView(_reactions);
 }
 
 class MemberListModel extends ChangeNotifier {