Merge remote-tracking branch 'pr/1530'

Author: gnprice

assets/icons/ZulipIcons.ttf

@@ -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 {

assets/icons/eye.svg

@@ -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,

assets/icons/eye_off.svg

@@ -110,6 +110,25 @@ 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;
+
+  // Mobile doesn't use the timestamp; ignore.
+  // final int timestamp;
+
+  const MutedUserItem({required this.id});
+
+  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:"

assets/icons/person.svg

@@ -645,6 +645,10 @@ class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStor
   @override
   Iterable<User> get allUsers => _users.allUsers;
 
+  @override
+  bool isUserMuted(int userId, {Set<int>? mutedUsers}) =>
+    _users.isUserMuted(userId, mutedUsers: mutedUsers);
+
   final UserStoreImpl _users;
 
   final TypingStatus typingStatus;
@@ -949,6 +953,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
     }

assets/icons/user.svg renamed to assets/icons/two_person.svg

@@ -66,6 +66,12 @@ mixin UserStore on PerAccountStoreBase {
     return getUser(message.senderId)?.fullName
       ?? message.senderFullName;
   }
+
+  /// Whether the user with [userId] is muted by the self-user.
+  ///
+  /// Looks for [userId] in a private [Set],
+  /// or in [mutedUsers] instead if that's non-null.
+  bool isUserMuted(int userId, {Set<int>? mutedUsers});
 }
 
 /// The implementation of [UserStore] that does the work.
@@ -81,7 +87,8 @@ 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 = Set.from(initialSnapshot.mutedUsers.map((item) => item.id));
 
   final Map<int, User> _users;
 
@@ -91,6 +98,13 @@ class UserStoreImpl extends PerAccountStoreBase with UserStore {
   @override
   Iterable<User> get allUsers => _users.values;
 
+  final Set<int> _mutedUsers;
+
+  @override
+  bool isUserMuted(int userId, {Set<int>? mutedUsers}) {
+    return (mutedUsers ?? _mutedUsers).contains(userId);
+  }
+
   void handleRealmUserEvent(RealmUserEvent event) {
     switch (event) {
       case RealmUserAddEvent():
@@ -129,4 +143,9 @@ class UserStoreImpl extends PerAccountStoreBase with UserStore {
         }
     }
   }
+
+  void handleMutedUsersEvent(MutedUsersEvent event) {
+    _mutedUsers.clear();
+    _mutedUsers.addAll(event.mutedUsers.map((item) => item.id));
+  }
 }

lib/api/model/events.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)),
@@ -549,7 +549,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) {

lib/api/model/events.g.dart

@@ -72,95 +72,104 @@ abstract final class ZulipIcons {
   /// The Zulip custom icon "edit".
   static const IconData edit = IconData(0xf110, fontFamily: "Zulip Icons");
 
+  /// The Zulip custom icon "eye".
+  static const IconData eye = IconData(0xf111, fontFamily: "Zulip Icons");
+
+  /// The Zulip custom icon "eye_off".
+  static const IconData eye_off = IconData(0xf112, fontFamily: "Zulip Icons");
+
   /// The Zulip custom icon "follow".
-  static const IconData follow = IconData(0xf111, fontFamily: "Zulip Icons");
+  static const IconData follow = IconData(0xf113, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "format_quote".
-  static const IconData format_quote = IconData(0xf112, fontFamily: "Zulip Icons");
+  static const IconData format_quote = IconData(0xf114, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "globe".
-  static const IconData globe = IconData(0xf113, fontFamily: "Zulip Icons");
+  static const IconData globe = IconData(0xf115, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "group_dm".
-  static const IconData group_dm = IconData(0xf114, fontFamily: "Zulip Icons");
+  static const IconData group_dm = IconData(0xf116, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "hash_italic".
-  static const IconData hash_italic = IconData(0xf115, fontFamily: "Zulip Icons");
+  static const IconData hash_italic = IconData(0xf117, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "hash_sign".
-  static const IconData hash_sign = IconData(0xf116, fontFamily: "Zulip Icons");
+  static const IconData hash_sign = IconData(0xf118, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "image".
-  static const IconData image = IconData(0xf117, fontFamily: "Zulip Icons");
+  static const IconData image = IconData(0xf119, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "inbox".
-  static const IconData inbox = IconData(0xf118, fontFamily: "Zulip Icons");
+  static const IconData inbox = IconData(0xf11a, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "info".
-  static const IconData info = IconData(0xf119, fontFamily: "Zulip Icons");
+  static const IconData info = IconData(0xf11b, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "inherit".
-  static const IconData inherit = IconData(0xf11a, fontFamily: "Zulip Icons");
+  static const IconData inherit = IconData(0xf11c, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "language".
-  static const IconData language = IconData(0xf11b, fontFamily: "Zulip Icons");
+  static const IconData language = IconData(0xf11d, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "lock".
-  static const IconData lock = IconData(0xf11c, fontFamily: "Zulip Icons");
+  static const IconData lock = IconData(0xf11e, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "menu".
-  static const IconData menu = IconData(0xf11d, fontFamily: "Zulip Icons");
+  static const IconData menu = IconData(0xf11f, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "message_checked".
-  static const IconData message_checked = IconData(0xf11e, fontFamily: "Zulip Icons");
+  static const IconData message_checked = IconData(0xf120, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "message_feed".
-  static const IconData message_feed = IconData(0xf11f, fontFamily: "Zulip Icons");
+  static const IconData message_feed = IconData(0xf121, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "mute".
-  static const IconData mute = IconData(0xf120, fontFamily: "Zulip Icons");
+  static const IconData mute = IconData(0xf122, fontFamily: "Zulip Icons");
+
+  /// The Zulip custom icon "person".
+  static const IconData person = IconData(0xf123, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "plus".
-  static const IconData plus = IconData(0xf121, fontFamily: "Zulip Icons");
+  static const IconData plus = IconData(0xf124, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "read_receipts".
-  static const IconData read_receipts = IconData(0xf122, fontFamily: "Zulip Icons");
+  static const IconData read_receipts = IconData(0xf125, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "send".
-  static const IconData send = IconData(0xf123, fontFamily: "Zulip Icons");
+  static const IconData send = IconData(0xf126, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "settings".
-  static const IconData settings = IconData(0xf124, fontFamily: "Zulip Icons");
+  static const IconData settings = IconData(0xf127, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "share".
-  static const IconData share = IconData(0xf125, fontFamily: "Zulip Icons");
+  static const IconData share = IconData(0xf128, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "share_ios".
-  static const IconData share_ios = IconData(0xf126, fontFamily: "Zulip Icons");
+  static const IconData share_ios = IconData(0xf129, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "smile".
-  static const IconData smile = IconData(0xf127, fontFamily: "Zulip Icons");
+  static const IconData smile = IconData(0xf12a, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "star".
-  static const IconData star = IconData(0xf128, fontFamily: "Zulip Icons");
+  static const IconData star = IconData(0xf12b, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "star_filled".
-  static const IconData star_filled = IconData(0xf129, fontFamily: "Zulip Icons");
+  static const IconData star_filled = IconData(0xf12c, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "three_person".
-  static const IconData three_person = IconData(0xf12a, fontFamily: "Zulip Icons");
+  static const IconData three_person = IconData(0xf12d, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "topic".
-  static const IconData topic = IconData(0xf12b, fontFamily: "Zulip Icons");
+  static const IconData topic = IconData(0xf12e, fontFamily: "Zulip Icons");
 
   /// The Zulip custom icon "topics".
-  static const IconData topics = IconData(0xf12c, fontFamily: "Zulip Icons");
+  static const IconData topics = IconData(0xf12f, fontFamily: "Zulip Icons");
 
-  /// The Zulip custom icon "unmute".
-  static const IconData unmute = IconData(0xf12d, fontFamily: "Zulip Icons");
+  /// The Zulip custom icon "two_person".
+  static const IconData two_person = IconData(0xf130, fontFamily: "Zulip Icons");
 
-  /// The Zulip custom icon "user".
-  static const IconData user = IconData(0xf12e, fontFamily: "Zulip Icons");
+  /// The Zulip custom icon "unmute".
+  static const IconData unmute = IconData(0xf131, fontFamily: "Zulip Icons");
 
   // END GENERATED ICON DATA
 }