chore: move timeline code (#94)

Author: Feichtmeier

lib/chat_room/common/view/chat_room_page.dart

@@ -44,7 +44,8 @@ class _ChatRoomPageState extends State<ChatRoomPage> {
   @override
   void initState() {
     super.initState();
-    _timelineFuture = widget.room.getTimeline(
+    _timelineFuture = di<TimelineModel>().loadTimeline(
+      widget.room,
       onNewEvent: () => _roomListKey.currentState?.setState(() {}),
       onChange: (i) => _roomListKey.currentState?.setState(() {}),
       onInsert: (i) => _roomListKey.currentState?.insertItem(i),

lib/chat_room/timeline/chat_room_timeline_list.dart

@@ -50,6 +50,7 @@ class _ChatRoomTimelineListState extends State<ChatRoomTimelineList> {
   @override
   void dispose() {
     _controller.dispose();
+    widget.timeline.cancelSubscriptions();
     super.dispose();
   }
 
@@ -71,6 +72,10 @@ class _ChatRoomTimelineListState extends State<ChatRoomTimelineList> {
         ).data ??
         [];
 
+    watchPropertyValue(
+      (TimelineModel m) => m.getUpdatingTimeline(widget.timeline.room.id),
+    );
+
     return Stack(
       children: [
         NotificationListener<ScrollEndNotification>(

lib/chat_room/timeline/timeline_model.dart

@@ -5,9 +5,33 @@ import '../../common/event_x.dart';
 import '../../common/logging.dart';
 
 class TimelineModel extends SafeChangeNotifier {
+  Future<Timeline> loadTimeline(
+    Room room, {
+    void Function(int)? onChange,
+    void Function(int)? onRemove,
+    void Function(int)? onInsert,
+    void Function()? onNewEvent,
+    void Function()? onUpdate,
+    String? eventContextId,
+    int? limit = Room.defaultHistoryCount,
+  }) async {
+    // This calls await postLoad() and then creates a new Timeline object
+    final timeline = await room.getTimeline(
+      onChange: onChange,
+      onRemove: onRemove,
+      onInsert: onInsert,
+      onNewEvent: onNewEvent,
+      onUpdate: onUpdate,
+      eventContextId: eventContextId,
+      limit: limit,
+    );
+
+    _setTimeline(timeline: timeline);
+    return timeline;
+  }
+
   Future<void> postTimelineLoad(Timeline timeline) async {
-    await loadRoomStates(timeline.room);
-    await loadAllKeysFromRoom(timeline);
+    _requestKeysForUndecryptableEvents(timeline);
     await requestHistory(timeline, historyCount: 500);
     await trySetReadMarker(timeline);
   }
@@ -71,26 +95,10 @@ class TimelineModel extends SafeChangeNotifier {
     }
   }
 
-  Future<void> loadAllKeysFromRoom(Timeline timeline) async {
+  // Request the keys for undecryptable events of this timeline
+  void _requestKeysForUndecryptableEvents(Timeline timeline) {
     try {
-      for (final event
-          in timeline.events
-              .toList(growable: false)
-              .where(
-                (e) =>
-                    e.isEncryptedAndCouldDecrypt &&
-                    !_hasLoadedKeys.contains(e.eventId),
-              )) {
-        await event.requestKey();
-        await timeline.room.client.encryption?.decryptRoomEvent(
-          event,
-          store: event.stateKey != null,
-        );
-        _hasLoadedKeys.add(event.eventId);
-        printMessageInDebugMode(
-          'Decrypted event ${event.eventId} in room ${timeline.room.getLocalizedDisplayname()}',
-        );
-      }
+      timeline.requestKeys(onlineKeyBackupOnly: false);
     } on Exception catch (e, s) {
       printMessageInDebugMode(e, s);
     }

lib/common/event_x.dart

@@ -32,6 +32,11 @@ extension EventX on Event {
     MatrixLocalizations? i18n,
   }) {
     i18n ??= i18n = const MatrixDefaultLocalizations();
+
+    if (type == EventTypes.RoomPinnedEvents) {
+      return 'Event was pinned';
+    }
+
     final maybeSpaceChildOrParentId =
         '${stateKey?.isNotEmpty == true && room.client.getRoomById(stateKey!) != null ? room.client.getRoomById(stateKey!)?.getLocalizedDisplayname() : l10n.unavailable}';
     if (type == 'm.space.parent') {
@@ -50,8 +55,11 @@ extension EventX on Event {
     return calcLocalizedBodyFallback(i18n);
   }
 
-  bool get showAsSpecialBadge =>
-      {'m.space.parent', 'm.space.child'}.contains(type);
+  bool get showAsSpecialBadge => {
+    'm.space.parent',
+    'm.space.child',
+    EventTypes.RoomPinnedEvents,
+  }.contains(type);
 
   bool get showAsBadge =>
       type.contains('m.call.') ||

lib/common/view/theme.dart

@@ -80,8 +80,8 @@ Color getMonochromeBg({
           : darkFactor ?? factor),
 );
 
-Color getEventBadgeColor(ThemeData theme, String type) =>
-    type == 'm.space.parent' || type == 'm.space.child'
+Color getEventBadgeColor(ThemeData theme, bool showAsSpecialBadge) =>
+    showAsSpecialBadge
     ? theme.colorScheme.primary
     : theme.colorScheme.onSurface.withValues(alpha: 0.2);
 

lib/events/view/chat_message_badge.dart

@@ -1,6 +1,7 @@
 import 'package:flutter/material.dart';
 import 'package:matrix/matrix.dart';
 
+import '../../common/event_x.dart';
 import '../../common/view/build_context_x.dart';
 import '../../common/view/theme.dart';
 import '../../common/view/ui_constants.dart';
@@ -33,7 +34,10 @@ class ChatMessageBadge extends StatelessWidget {
             Flexible(
               child: Badge(
                 textColor: getEventBadgeTextColor(theme, displayEvent.type),
-                backgroundColor: getEventBadgeColor(theme, displayEvent.type),
+                backgroundColor: getEventBadgeColor(
+                  theme,
+                  displayEvent.showAsSpecialBadge,
+                ),
                 label: ConstrainedBox(
                   constraints: const BoxConstraints(
                     maxWidth: 400,