implemented the Ticker module with a native ProseMirror document renderer and integrated API support for structured content, navigation trees, and proxied files

2026-07-09 00:51:08 +02:00
parent 1114291313
commit cedeb06569
57 changed files with 4758 additions and 43 deletions
@@ -5,6 +5,7 @@ import 'package:persistent_bottom_nav_bar_v2/persistent_bottom_nav_bar_v2.dart';

 import '../../../api/marianumconnect/queries/get_breakers/get_breakers_response.dart';
 import '../../../routing/app_routes.dart';
+import '../../../storage/modules_settings.dart';
 import '../../../view/pages/files/files.dart';
 import '../../../view/pages/grade_averages/grade_averages_view.dart';
 import '../../../view/pages/holidays/holidays_view.dart';
@@ -12,6 +13,7 @@ import '../../../view/pages/marianum_dates/marianum_dates_view.dart';
 import '../../../view/pages/marianum_message/marianum_message_list_view.dart';
 import '../../../view/pages/more/roomplan/roomplan.dart';
 import '../../../view/pages/talk/chat_list.dart';
+import '../../../view/pages/ticker/ticker_view.dart';
 import '../../../view/pages/timetable/timetable.dart';
 import '../../../widget/breaker/breaker.dart';
 import '../../../widget/centered_leading.dart';
@@ -48,6 +50,15 @@ class AppModule {
        breakerArea: BreakerArea.timetable,
        create: Timetable.new,
      ),
+      Modules.ticker: AppModule(
+        Modules.ticker,
+        name: 'Ticker',
+        // Icons.newspaper is already taken by the "Marianum Message" module;
+        // use feed to keep the two visually distinct.
+        icon: () => Icon(Icons.feed),
+        breakerArea: BreakerArea.ticker,
+        create: TickerView.new,
+      ),
      Modules.talk: AppModule(
        Modules.talk,
        name: 'Talk',
@@ -136,13 +147,59 @@ class AppModule {
    }

    return {
-      for (var element in settings.val().modulesSettings.moduleOrder.where(
-        (element) => available.containsKey(element),
-      ))
+      for (var element in effectiveModuleOrder(
+        settings.val().modulesSettings,
+      ).where((element) => available.containsKey(element)))
        element: available[element]!,
    };
  }

+  // A persisted moduleOrder predates modules added in newer app versions.
+  // Deriving the effective order at read time (instead of relying on a heal
+  // during hydration) makes it impossible for a module to vanish from the
+  // bottom bar, the "Mehr" menu and the settings list at once. Missing
+  // modules are inserted right after their closest declared predecessor so
+  // they land at their default position (e.g. the ticker between Stundenplan
+  // and Talk) instead of at the end of the "Mehr" menu.
+  static List<Modules> effectiveModuleOrder(ModulesSettings settings) {
+    final seen = <Modules>{};
+    final order = [
+      for (final m in settings.moduleOrder)
+        if (seen.add(m)) m,
+    ];
+    for (final missing in Modules.values) {
+      if (!seen.add(missing)) continue;
+      var insertAt = 0;
+      for (final predecessor in Modules.values.takeWhile(
+        (m) => m != missing,
+      )) {
+        final pos = order.indexOf(predecessor);
+        if (pos >= insertAt) insertAt = pos + 1;
+      }
+      order.insert(insertAt, missing);
+    }
+    return order;
+  }
+
+  // The settings list displays a capability-filtered subset, so reorder
+  // indices refer to that subset; the move is applied there and merged back
+  // into the full order (non-displayed modules keep their relative slots).
+  static List<Modules> reorderModuleOrder({
+    required List<Modules> displayed,
+    required List<Modules> effective,
+    required int oldIndex,
+    required int newIndex,
+  }) {
+    final moved = List<Modules>.from(displayed);
+    moved.insert(newIndex, moved.removeAt(oldIndex));
+    final displayedSet = displayed.toSet();
+    var moveIndex = 0;
+    return [
+      for (final m in effective)
+        displayedSet.contains(m) ? moved[moveIndex++] : m,
+    ];
+  }
+
  static const int minBottomBarSlots = 3;
  static const int maxBottomBarSlots = 5;

@@ -152,14 +209,9 @@ class AppModule {

    int desired;
    if (settings.autoFillBottomBar) {
-      final width = MediaQuery.of(context).size.width;
-      if (width >= 840) {
-        desired = 5;
-      } else if (width >= 600) {
-        desired = 4;
-      } else {
-        desired = 3;
-      }
+      // 4 content tabs so the bar shows 5 entries including "Mehr" — enough
+      // for the Ticker module without pushing "Dateien" into the overflow.
+      desired = 4;
    } else {
      desired = settings.fixedBottomBarSlots;
    }
@@ -225,6 +277,7 @@ class AppModule {

 enum Modules {
  timetable,
+  ticker,
  talk,
  files,
  marianumMessage,
@@ -6,7 +6,6 @@ import 'package:hydrated_bloc/hydrated_bloc.dart';
 import '../../../../../storage/settings.dart';
 import '../../../../../utils/debouncer.dart';
 import '../../../../../view/pages/settings/data/default_settings.dart';
-import '../../app_modules.dart';

 class SettingsCubit extends HydratedCubit<Settings> {
  static const _debounceTag = 'settings_persist';
@@ -47,16 +46,17 @@ class SettingsCubit extends HydratedCubit<Settings> {
    emit(DefaultSettings.get());
  }

+  // Modules missing from a stale persisted moduleOrder are handled at read
+  // time by AppModule.effectiveModuleOrder (inserted at their default
+  // position) — no healing on hydration needed.
  @override
  Settings fromJson(Map<String, dynamic> json) {
    try {
-      return _appendNewModules(Settings.fromJson(json));
+      return Settings.fromJson(json);
    } catch (_) {
      try {
-        return _appendNewModules(
-          Settings.fromJson(
-            _mergeSettings(json, DefaultSettings.get().toJson()),
-          ),
+        return Settings.fromJson(
+          _mergeSettings(json, DefaultSettings.get().toJson()),
        );
      } catch (_) {
        return DefaultSettings.get();
@@ -64,20 +64,6 @@ class SettingsCubit extends HydratedCubit<Settings> {
    }
  }

-  // Modules added in newer app versions won't appear in a previously persisted
-  // moduleOrder. Append any enum value that is neither ordered nor hidden so it
-  // becomes visible in the "Mehr" menu without forcing a full settings reset.
-  Settings _appendNewModules(Settings s) {
-    final order = s.modulesSettings.moduleOrder;
-    final hidden = s.modulesSettings.hiddenModules;
-    final missing = Modules.values.where(
-      (m) => !order.contains(m) && !hidden.contains(m),
-    );
-    if (missing.isEmpty) return s;
-    s.modulesSettings.moduleOrder = [...order, ...missing];
-    return s;
-  }
-
  @override
  Map<String, dynamic>? toJson(Settings state) => state.toJson();

@@ -0,0 +1,31 @@
+import '../../../../../api/marianumconnect/queries/get_ticker/get_ticker_response.dart';
+import '../../../../../api/marianumconnect/queries/get_ticker_nav/get_ticker_nav_response.dart';
+import '../../../infrastructure/utility_widgets/loadable_hydrated_bloc/loadable_hydrated_bloc.dart';
+import '../../../infrastructure/utility_widgets/loadable_hydrated_bloc/loadable_hydrated_bloc_event.dart';
+import '../repository/ticker_repository.dart';
+import 'ticker_event.dart';
+import 'ticker_state.dart';
+
+class TickerBloc
+    extends LoadableHydratedBloc<TickerEvent, TickerState, TickerRepository> {
+  @override
+  Future<void> gatherData() async {
+    final results = await Future.wait([repo.getTicker(), repo.getNav()]);
+    final ticker = results[0] as TickerResponse;
+    final nav = results[1] as TickerNavResponse;
+    add(DataGathered((state) => state.copyWith(ticker: ticker, nav: nav)));
+  }
+
+  @override
+  TickerRepository repository() => TickerRepository();
+
+  @override
+  TickerState fromNothing() => const TickerState();
+
+  @override
+  TickerState fromStorage(Map<String, dynamic> json) =>
+      TickerState.fromJson(json);
+
+  @override
+  Map<String, dynamic>? toStorage(TickerState state) => state.toJson();
+}
@@ -0,0 +1,6 @@
+import '../../../infrastructure/utility_widgets/loadable_hydrated_bloc/loadable_hydrated_bloc_event.dart';
+import 'ticker_state.dart';
+
+sealed class TickerEvent extends LoadableHydratedBlocEvent<TickerState> {}
+
+class TickerLoadEvent extends TickerEvent {}
@@ -0,0 +1,19 @@
+import 'package:freezed_annotation/freezed_annotation.dart';
+
+import '../../../../../api/marianumconnect/queries/get_ticker/get_ticker_response.dart';
+import '../../../../../api/marianumconnect/queries/get_ticker_nav/get_ticker_nav_response.dart';
+
+part 'ticker_state.freezed.dart';
+part 'ticker_state.g.dart';
+
+/// Hydrated ticker module state: the current "Aktuelles" post plus the filtered
+/// page tree. Page contents are loaded on demand in the detail screen and are
+/// deliberately not cached here.
+@freezed
+abstract class TickerState with _$TickerState {
+  const factory TickerState({TickerResponse? ticker, TickerNavResponse? nav}) =
+      _TickerState;
+
+  factory TickerState.fromJson(Map<String, dynamic> json) =>
+      _$TickerStateFromJson(json);
+}
@@ -0,0 +1,280 @@
+// GENERATED CODE - DO NOT MODIFY BY HAND
+// coverage:ignore-file
+// ignore_for_file: type=lint
+// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark
+
+part of 'ticker_state.dart';
+
+// **************************************************************************
+// FreezedGenerator
+// **************************************************************************
+
+// dart format off
+T _$identity<T>(T value) => value;
+
+/// @nodoc
+mixin _$TickerState {
+
+ TickerResponse? get ticker; TickerNavResponse? get nav;
+/// Create a copy of TickerState
+/// with the given fields replaced by the non-null parameter values.
+@JsonKey(includeFromJson: false, includeToJson: false)
+@pragma('vm:prefer-inline')
+$TickerStateCopyWith<TickerState> get copyWith => _$TickerStateCopyWithImpl<TickerState>(this as TickerState, _$identity);
+
+  /// Serializes this TickerState to a JSON map.
+  Map<String, dynamic> toJson();
+
+
+@override
+bool operator ==(Object other) {
+  return identical(this, other) || (other.runtimeType == runtimeType&&other is TickerState&&(identical(other.ticker, ticker) || other.ticker == ticker)&&(identical(other.nav, nav) || other.nav == nav));
+}
+
+@JsonKey(includeFromJson: false, includeToJson: false)
+@override
+int get hashCode => Object.hash(runtimeType,ticker,nav);
+
+@override
+String toString() {
+  return 'TickerState(ticker: $ticker, nav: $nav)';
+}
+
+
+}
+
+/// @nodoc
+abstract mixin class $TickerStateCopyWith<$Res>  {
+  factory $TickerStateCopyWith(TickerState value, $Res Function(TickerState) _then) = _$TickerStateCopyWithImpl;
+@useResult
+$Res call({
+ TickerResponse? ticker, TickerNavResponse? nav
+});
+
+
+
+
+}
+/// @nodoc
+class _$TickerStateCopyWithImpl<$Res>
+    implements $TickerStateCopyWith<$Res> {
+  _$TickerStateCopyWithImpl(this._self, this._then);
+
+  final TickerState _self;
+  final $Res Function(TickerState) _then;
+
+/// Create a copy of TickerState
+/// with the given fields replaced by the non-null parameter values.
+@pragma('vm:prefer-inline') @override $Res call({Object? ticker = freezed,Object? nav = freezed,}) {
+  return _then(_self.copyWith(
+ticker: freezed == ticker ? _self.ticker : ticker // ignore: cast_nullable_to_non_nullable
+as TickerResponse?,nav: freezed == nav ? _self.nav : nav // ignore: cast_nullable_to_non_nullable
+as TickerNavResponse?,
+  ));
+}
+
+}
+
+
+/// Adds pattern-matching-related methods to [TickerState].
+extension TickerStatePatterns on TickerState {
+/// A variant of `map` that fallback to returning `orElse`.
+///
+/// It is equivalent to doing:
+/// ```dart
+/// switch (sealedClass) {
+///   case final Subclass value:
+///     return ...;
+///   case _:
+///     return orElse();
+/// }
+/// ```
+
+@optionalTypeArgs TResult maybeMap<TResult extends Object?>(TResult Function( _TickerState value)?  $default,{required TResult orElse(),}){
+final _that = this;
+switch (_that) {
+case _TickerState() when $default != null:
+return $default(_that);case _:
+  return orElse();
+
+}
+}
+/// A `switch`-like method, using callbacks.
+///
+/// Callbacks receives the raw object, upcasted.
+/// It is equivalent to doing:
+/// ```dart
+/// switch (sealedClass) {
+///   case final Subclass value:
+///     return ...;
+///   case final Subclass2 value:
+///     return ...;
+/// }
+/// ```
+
+@optionalTypeArgs TResult map<TResult extends Object?>(TResult Function( _TickerState value)  $default,){
+final _that = this;
+switch (_that) {
+case _TickerState():
+return $default(_that);case _:
+  throw StateError('Unexpected subclass');
+
+}
+}
+/// A variant of `map` that fallback to returning `null`.
+///
+/// It is equivalent to doing:
+/// ```dart
+/// switch (sealedClass) {
+///   case final Subclass value:
+///     return ...;
+///   case _:
+///     return null;
+/// }
+/// ```
+
+@optionalTypeArgs TResult? mapOrNull<TResult extends Object?>(TResult? Function( _TickerState value)?  $default,){
+final _that = this;
+switch (_that) {
+case _TickerState() when $default != null:
+return $default(_that);case _:
+  return null;
+
+}
+}
+/// A variant of `when` that fallback to an `orElse` callback.
+///
+/// It is equivalent to doing:
+/// ```dart
+/// switch (sealedClass) {
+///   case Subclass(:final field):
+///     return ...;
+///   case _:
+///     return orElse();
+/// }
+/// ```
+
+@optionalTypeArgs TResult maybeWhen<TResult extends Object?>(TResult Function( TickerResponse? ticker,  TickerNavResponse? nav)?  $default,{required TResult orElse(),}) {final _that = this;
+switch (_that) {
+case _TickerState() when $default != null:
+return $default(_that.ticker,_that.nav);case _:
+  return orElse();
+
+}
+}
+/// A `switch`-like method, using callbacks.
+///
+/// As opposed to `map`, this offers destructuring.
+/// It is equivalent to doing:
+/// ```dart
+/// switch (sealedClass) {
+///   case Subclass(:final field):
+///     return ...;
+///   case Subclass2(:final field2):
+///     return ...;
+/// }
+/// ```
+
+@optionalTypeArgs TResult when<TResult extends Object?>(TResult Function( TickerResponse? ticker,  TickerNavResponse? nav)  $default,) {final _that = this;
+switch (_that) {
+case _TickerState():
+return $default(_that.ticker,_that.nav);case _:
+  throw StateError('Unexpected subclass');
+
+}
+}
+/// A variant of `when` that fallback to returning `null`
+///
+/// It is equivalent to doing:
+/// ```dart
+/// switch (sealedClass) {
+///   case Subclass(:final field):
+///     return ...;
+///   case _:
+///     return null;
+/// }
+/// ```
+
+@optionalTypeArgs TResult? whenOrNull<TResult extends Object?>(TResult? Function( TickerResponse? ticker,  TickerNavResponse? nav)?  $default,) {final _that = this;
+switch (_that) {
+case _TickerState() when $default != null:
+return $default(_that.ticker,_that.nav);case _:
+  return null;
+
+}
+}
+
+}
+
+/// @nodoc
+@JsonSerializable()
+
+class _TickerState implements TickerState {
+  const _TickerState({this.ticker, this.nav});
+  factory _TickerState.fromJson(Map<String, dynamic> json) => _$TickerStateFromJson(json);
+
+@override final  TickerResponse? ticker;
+@override final  TickerNavResponse? nav;
+
+/// Create a copy of TickerState
+/// with the given fields replaced by the non-null parameter values.
+@override @JsonKey(includeFromJson: false, includeToJson: false)
+@pragma('vm:prefer-inline')
+_$TickerStateCopyWith<_TickerState> get copyWith => __$TickerStateCopyWithImpl<_TickerState>(this, _$identity);
+
+@override
+Map<String, dynamic> toJson() {
+  return _$TickerStateToJson(this, );
+}
+
+@override
+bool operator ==(Object other) {
+  return identical(this, other) || (other.runtimeType == runtimeType&&other is _TickerState&&(identical(other.ticker, ticker) || other.ticker == ticker)&&(identical(other.nav, nav) || other.nav == nav));
+}
+
+@JsonKey(includeFromJson: false, includeToJson: false)
+@override
+int get hashCode => Object.hash(runtimeType,ticker,nav);
+
+@override
+String toString() {
+  return 'TickerState(ticker: $ticker, nav: $nav)';
+}
+
+
+}
+
+/// @nodoc
+abstract mixin class _$TickerStateCopyWith<$Res> implements $TickerStateCopyWith<$Res> {
+  factory _$TickerStateCopyWith(_TickerState value, $Res Function(_TickerState) _then) = __$TickerStateCopyWithImpl;
+@override @useResult
+$Res call({
+ TickerResponse? ticker, TickerNavResponse? nav
+});
+
+
+
+
+}
+/// @nodoc
+class __$TickerStateCopyWithImpl<$Res>
+    implements _$TickerStateCopyWith<$Res> {
+  __$TickerStateCopyWithImpl(this._self, this._then);
+
+  final _TickerState _self;
+  final $Res Function(_TickerState) _then;
+
+/// Create a copy of TickerState
+/// with the given fields replaced by the non-null parameter values.
+@override @pragma('vm:prefer-inline') $Res call({Object? ticker = freezed,Object? nav = freezed,}) {
+  return _then(_TickerState(
+ticker: freezed == ticker ? _self.ticker : ticker // ignore: cast_nullable_to_non_nullable
+as TickerResponse?,nav: freezed == nav ? _self.nav : nav // ignore: cast_nullable_to_non_nullable
+as TickerNavResponse?,
+  ));
+}
+
+
+}
+
+// dart format on
@@ -0,0 +1,19 @@
+// GENERATED CODE - DO NOT MODIFY BY HAND
+
+part of 'ticker_state.dart';
+
+// **************************************************************************
+// JsonSerializableGenerator
+// **************************************************************************
+
+_TickerState _$TickerStateFromJson(Map<String, dynamic> json) => _TickerState(
+  ticker: json['ticker'] == null
+      ? null
+      : TickerResponse.fromJson(json['ticker'] as Map<String, dynamic>),
+  nav: json['nav'] == null
+      ? null
+      : TickerNavResponse.fromJson(json['nav'] as Map<String, dynamic>),
+);
+
+Map<String, dynamic> _$TickerStateToJson(_TickerState instance) =>
+    <String, dynamic>{'ticker': instance.ticker, 'nav': instance.nav};
@@ -0,0 +1,35 @@
+import 'dart:typed_data';
+
+import '../../../../../api/demo/data/demo_ticker.dart';
+import '../../../../../api/demo/demo_mode.dart';
+import '../../../../../api/marianumconnect/queries/get_ticker/get_ticker.dart';
+import '../../../../../api/marianumconnect/queries/get_ticker/get_ticker_response.dart';
+import '../../../../../api/marianumconnect/queries/get_ticker_nav/get_ticker_nav.dart';
+import '../../../../../api/marianumconnect/queries/get_ticker_nav/get_ticker_nav_response.dart';
+import '../../../../../api/marianumconnect/queries/get_ticker_page/get_ticker_page.dart';
+import '../../../../../api/marianumconnect/queries/get_ticker_page/get_ticker_page_response.dart';
+import '../../../../../api/marianumconnect/queries/get_ticker_page_file/get_ticker_page_file.dart';
+import '../../../infrastructure/repository/repository.dart';
+import '../bloc/ticker_state.dart';
+
+class TickerRepository extends Repository<TickerState> {
+  Future<TickerResponse> getTicker() {
+    if (DemoMode.active) return Future.value(DemoTicker.ticker());
+    return GetTicker().run();
+  }
+
+  Future<TickerNavResponse> getNav() {
+    if (DemoMode.active) return Future.value(DemoTicker.nav());
+    return GetTickerNav().run();
+  }
+
+  Future<TickerPageResponse> getPage(String slug) {
+    if (DemoMode.active) return Future.value(DemoTicker.page(slug));
+    return GetTickerPage(slug).run();
+  }
+
+  Future<Uint8List> getPageFile(String slug) {
+    if (DemoMode.active) return Future.value(Uint8List(0));
+    return GetTickerPageFile(slug).run();
+  }
+}
@@ -15,10 +15,9 @@ T _$identity<T>(T value) => value;
 /// @nodoc
 mixin _$TimetableState {

- Map<String, TimetableGetWeekResponse> get weekCache; TimetableGetRoomsResponse? get rooms; TimetableGetSubjectsResponse? get subjects; TimetableGetHolidaysResponse? get schoolHolidays; TimetableGetSchoolyearResponse? get schoolyear; TimetableGetTimegridResponse? get timegrid; GetCustomTimetableEventResponse? get customEvents; DateTime get startDate; DateTime get endDate; int get dataVersion;// Boundaries learned from past server denials of inaccessible weeks.
-// Inclusive: weeks whose start is on/before `accessibleEndDate` and
-// whose end is on/after `accessibleStartDate` are within the user's
-// permitted range. Null = no upper / lower bound discovered yet.
+ Map<String, TimetableGetWeekResponse> get weekCache; TimetableGetRoomsResponse? get rooms; TimetableGetSubjectsResponse? get subjects; TimetableGetHolidaysResponse? get schoolHolidays; TimetableGetSchoolyearResponse? get schoolyear; TimetableGetTimegridResponse? get timegrid; GetCustomTimetableEventResponse? get customEvents; DateTime get startDate; DateTime get endDate; int get dataVersion;// Boundaries learned from past server denials. A week is permitted when its
+// start is on/before `accessibleEndDate` and its end on/after
+// `accessibleStartDate`. Null = that bound not discovered yet.
 DateTime? get accessibleStartDate; DateTime? get accessibleEndDate;
 /// Create a copy of TimetableState
 /// with the given fields replaced by the non-null parameter values.
@@ -243,10 +242,9 @@ class _TimetableState extends TimetableState {
@override final  DateTime startDate;
@override final  DateTime endDate;
@override@JsonKey() final  int dataVersion;
-// Boundaries learned from past server denials of inaccessible weeks.
-// Inclusive: weeks whose start is on/before `accessibleEndDate` and
-// whose end is on/after `accessibleStartDate` are within the user's
-// permitted range. Null = no upper / lower bound discovered yet.
+// Boundaries learned from past server denials. A week is permitted when its
+// start is on/before `accessibleEndDate` and its end on/after
+// `accessibleStartDate`. Null = that bound not discovered yet.
@override final  DateTime? accessibleStartDate;
@override final  DateTime? accessibleEndDate;