Muted users prep

lib/api/model/events.dart

@@ -62,6 +62,7 @@ sealed class Event {
         }
       // case 'muted_topics': … // TODO(#422) we ignore this feature on older servers
       case 'user_topic': return UserTopicEvent.fromJson(json);
+      case 'muted_users': return MutedUsersEvent.fromJson(json);
       case 'message': return MessageEvent.fromJson(json);
       case 'update_message': return UpdateMessageEvent.fromJson(json);
       case 'delete_message': return DeleteMessageEvent.fromJson(json);
@@ -733,6 +734,24 @@ class UserTopicEvent extends Event {
   Map<String, dynamic> toJson() => _$UserTopicEventToJson(this);
 }
 
+/// A Zulip event of type `muted_users`: https://zulip.com/api/get-events#muted_users
+@JsonSerializable(fieldRename: FieldRename.snake)
+class MutedUsersEvent extends Event {
+  @override
+  @JsonKey(includeToJson: true)
+  String get type => 'muted_users';
+
+  final List<MutedUserItem> mutedUsers;
+
+  MutedUsersEvent({required super.id, required this.mutedUsers});
+
+  factory MutedUsersEvent.fromJson(Map<String, dynamic> json) =>
+    _$MutedUsersEventFromJson(json);
+
+  @override
+  Map<String, dynamic> toJson() => _$MutedUsersEventToJson(this);
+}
+
 /// A Zulip event of type `message`: https://zulip.com/api/get-events#message
 @JsonSerializable(fieldRename: FieldRename.snake)
 class MessageEvent extends Event {

lib/api/model/initial_snapshot.dart

@@ -44,6 +44,8 @@ class InitialSnapshot {
 
   // final List<…> mutedTopics; // TODO(#422) we ignore this feature on older servers
 
+  final List<MutedUserItem> mutedUsers;
+
   final Map<String, RealmEmojiItem> realmEmoji;
 
   final List<RecentDmConversation> recentPrivateConversations;
@@ -132,6 +134,7 @@ class InitialSnapshot {
     required this.serverTypingStartedExpiryPeriodMilliseconds,
     required this.serverTypingStoppedWaitPeriodMilliseconds,
     required this.serverTypingStartedWaitPeriodMilliseconds,
+    required this.mutedUsers,
     required this.realmEmoji,
     required this.recentPrivateConversations,
     required this.savedSnippets,

lib/api/model/model.dart

@@ -110,6 +110,24 @@ class CustomProfileFieldExternalAccountData {
   Map<String, dynamic> toJson() => _$CustomProfileFieldExternalAccountDataToJson(this);
 }
 
+
+/// An item in the [InitialSnapshot.mutedUsers] or [MutedUsersEvent].
+///
+/// For docs, search for "muted_users:"
+/// in <https://zulip.com/api/register-queue>.
+@JsonSerializable(fieldRename: FieldRename.snake)
+class MutedUserItem {
+  final int id;
+  final int timestamp;
+
+  const MutedUserItem({required this.id, required this.timestamp});
+
+  factory MutedUserItem.fromJson(Map<String, dynamic> json) =>
+    _$MutedUserItemFromJson(json);
+
+  Map<String, dynamic> toJson() => _$MutedUserItemToJson(this);
+}
+
 /// An item in [InitialSnapshot.realmEmoji] or [RealmEmojiUpdateEvent].
 ///
 /// For docs, search for "realm_emoji:"

lib/model/store.dart

@@ -644,6 +644,13 @@ class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStor
   @override
   Iterable<User> get allUsers => _users.allUsers;
 
+  @override
+  List<MutedUserItem> get mutedUsers => _users.mutedUsers;
+
+  @override
+  bool isUserMuted(int id, {List<MutedUserItem>? mutedUsers}) =>
+    _users.isUserMuted(id, mutedUsers: mutedUsers);
+
   final UserStoreImpl _users;
 
   final TypingStatus typingStatus;
@@ -943,6 +950,11 @@ class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStor
         assert(debugLog("server event: reaction/${event.op}"));
         _messages.handleReactionEvent(event);
 
+      case MutedUsersEvent():
+        assert(debugLog("server event: muted_users"));
+        _users.handleMutedUsersEvent(event);
+        notifyListeners();
+
       case UnexpectedEvent():
         assert(debugLog("server event: ${jsonEncode(event.toJson())}")); // TODO log better
     }

lib/model/user.dart

@@ -1,7 +1,9 @@
 import '../api/model/events.dart';
 import '../api/model/initial_snapshot.dart';
 import '../api/model/model.dart';
+import 'algorithms.dart';
 import 'localizations.dart';
+import 'narrow.dart';
 import 'store.dart';
 
 /// The portion of [PerAccountStore] describing the users in the realm.
@@ -66,6 +68,24 @@ mixin UserStore on PerAccountStoreBase {
     return getUser(message.senderId)?.fullName
       ?? message.senderFullName;
   }
+
+  /// All the users muted by [selfUser], sorted by [MutedUserItem.id] ascending.
+  List<MutedUserItem> get mutedUsers;
+
+  /// Whether the user with the given [id] is muted by [selfUser].
+  ///
+  /// By default, looks for the user id in [UserStore.mutedUsers] unless
+  /// [mutedUsers] is non-null, in which case looks in the latter.
+  bool isUserMuted(int id, {List<MutedUserItem>? mutedUsers});
+
+  /// Whether all of the users corresponding to [DmNarrow.otherRecipientIds]
+  /// are muted by [selfUser];
+  ///
+  /// By default, looks for the recipients in [UserStore.mutedUsers] unless
+  /// [mutedUsers] is non-null, in which case looks in the latter.
+  bool allRecipientsMuted(DmNarrow narrow, {List<MutedUserItem>? mutedUsers}) {
+    return !narrow.otherRecipientIds.any((id) => !isUserMuted(id, mutedUsers: mutedUsers));
+  }
 }
 
 /// The implementation of [UserStore] that does the work.
@@ -81,16 +101,31 @@ class UserStoreImpl extends PerAccountStoreBase with UserStore {
          initialSnapshot.realmUsers
          .followedBy(initialSnapshot.realmNonActiveUsers)
          .followedBy(initialSnapshot.crossRealmBots)
-         .map((user) => MapEntry(user.userId, user)));
+         .map((user) => MapEntry(user.userId, user))),
+       mutedUsers = _sortMutedUsers(initialSnapshot.mutedUsers);
 
   final Map<int, User> _users;
 
+  @override
+  final List<MutedUserItem> mutedUsers;
+
   @override
   User? getUser(int userId) => _users[userId];
 
   @override
   Iterable<User> get allUsers => _users.values;
 
+  @override
+  bool isUserMuted(int id, {List<MutedUserItem>? mutedUsers}) {
+    return binarySearchByKey(
+      mutedUsers == null ? this.mutedUsers : _sortMutedUsers(mutedUsers), id,
+      (item, id) => item.id.compareTo(id)) >= 0;
+  }
+
+  static List<MutedUserItem> _sortMutedUsers(List<MutedUserItem> mutedUsers) {
+    return mutedUsers..sort((a, b) => a.id.compareTo(b.id));
+  }
+
   void handleRealmUserEvent(RealmUserEvent event) {
     switch (event) {
       case RealmUserAddEvent():
@@ -129,4 +164,9 @@ class UserStoreImpl extends PerAccountStoreBase with UserStore {
         }
     }
   }
+
+  void handleMutedUsersEvent(MutedUsersEvent event) {
+    mutedUsers.clear();
+    mutedUsers.addAll(_sortMutedUsers(event.mutedUsers));
+  }
 }

lib/widgets/home.dart

@@ -111,7 +111,7 @@ class _HomePageState extends State<HomePage> {
             narrow: const CombinedFeedNarrow()))),
       button(_HomePageTab.channels,       ZulipIcons.hash_italic),
       // TODO(#1094): Users
-      button(_HomePageTab.directMessages, ZulipIcons.user),
+      button(_HomePageTab.directMessages, ZulipIcons.two_person),
       _NavigationBarButton(         icon: ZulipIcons.menu,
         selected: false,
         onPressed: () => _showMainMenu(context, tabNotifier: _tab)),
@@ -515,7 +515,7 @@ class _DirectMessagesButton extends _NavigationBarMenuButton {
   const _DirectMessagesButton({required super.tabNotifier});
 
   @override
-  IconData get icon => ZulipIcons.user;
+  IconData get icon => ZulipIcons.two_person;
 
   @override
   String label(ZulipLocalizations zulipLocalizations) {