added support for translations and printing

2026-03-05 07:29:15 +01:00
parent ce014e40bf
commit c3e39b3a1d
28 changed files with 3547 additions and 2837 deletions
@@ -27,6 +27,7 @@ import 'package:weblibre/features/geckoview/domain/entities/states/find_result.d
 import 'package:weblibre/features/geckoview/domain/entities/states/history.dart';
 import 'package:weblibre/features/geckoview/domain/entities/states/readerable.dart';
 import 'package:weblibre/features/geckoview/domain/entities/states/security.dart';
+import 'package:weblibre/features/geckoview/domain/entities/states/translation.dart';
 import 'package:weblibre/features/geckoview/features/tabs/data/entities/tab_mode.dart';

 part 'tab.g.dart';
@@ -75,6 +76,7 @@ class TabState extends WebPageInfo {
  final HistoryState historyState;
  final ReaderableState readerableState;
  final FindResultState findResultState;
+  final TranslationState translationState;

  TabState({
    required this.id,
@@ -93,6 +95,7 @@ class TabState extends WebPageInfo {
    required this.historyState,
    required this.readerableState,
    required this.findResultState,
+    required this.translationState,
  }) : super(title: title.trim());

  factory TabState.$default(String tabId) => TabState(
@@ -111,6 +114,7 @@ class TabState extends WebPageInfo {
    historyState: HistoryState.$default(),
    readerableState: ReaderableState.$default(),
    findResultState: FindResultState.$default(),
+    translationState: TranslationState.$default(),
  );

  @override
@@ -130,5 +134,6 @@ class TabState extends WebPageInfo {
    historyState,
    readerableState,
    findResultState,
+    translationState,
  ];
 }
@@ -37,6 +37,8 @@ abstract class _$TabStateCWProxy {

  TabState findResultState(FindResultState findResultState);

+  TabState translationState(TranslationState translationState);
+
  /// Creates a new instance with the provided field values.
  /// Passing `null` to a nullable field nullifies it, while `null` for a non-nullable field is ignored. To update a single field use `TabState(...).copyWith.fieldName(value)`.
  ///
@@ -60,6 +62,7 @@ abstract class _$TabStateCWProxy {
    HistoryState historyState,
    ReaderableState readerableState,
    FindResultState findResultState,
+    TranslationState translationState,
  });
 }

@@ -120,6 +123,10 @@ class _$TabStateCWProxyImpl implements _$TabStateCWProxy {
  TabState findResultState(FindResultState findResultState) =>
      call(findResultState: findResultState);

+  @override
+  TabState translationState(TranslationState translationState) =>
+      call(translationState: translationState);
+
  @override
  /// Creates a new instance with the provided field values.
  /// Passing `null` to a nullable field nullifies it, while `null` for a non-nullable field is ignored. To update a single field use `TabState(...).copyWith.fieldName(value)`.
@@ -144,6 +151,7 @@ class _$TabStateCWProxyImpl implements _$TabStateCWProxy {
    Object? historyState = const $CopyWithPlaceholder(),
    Object? readerableState = const $CopyWithPlaceholder(),
    Object? findResultState = const $CopyWithPlaceholder(),
+    Object? translationState = const $CopyWithPlaceholder(),
  }) {
    return TabState(
      id: _value.id,
@@ -217,6 +225,12 @@ class _$TabStateCWProxyImpl implements _$TabStateCWProxy {
          ? _value.findResultState
          // ignore: cast_nullable_to_non_nullable
          : findResultState as FindResultState,
+      translationState:
+          translationState == const $CopyWithPlaceholder() ||
+              translationState == null
+          ? _value.translationState
+          // ignore: cast_nullable_to_non_nullable
+          : translationState as TranslationState,
    );
  }
 }
@@ -0,0 +1,85 @@
+/*
+ * Copyright (c) 2024-2026 Fabian Freund.
+ *
+ * This file is part of WebLibre
+ * (see https://weblibre.eu).
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+import 'package:fast_equatable/fast_equatable.dart';
+import 'package:flutter_mozilla_components/flutter_mozilla_components.dart';
+
+class TranslationState with FastEquatable {
+  final bool isTranslated;
+  final bool isTranslateProcessing;
+  final bool isOfferTranslate;
+  final bool isExpectedTranslate;
+  final String? detectedLanguageCode;
+  final String? userPreferredLanguageCode;
+  final String? requestedFromLanguage;
+  final String? requestedToLanguage;
+  final String? translationErrorName;
+  final bool? displayError;
+
+  TranslationState({
+    required this.isTranslated,
+    required this.isTranslateProcessing,
+    required this.isOfferTranslate,
+    required this.isExpectedTranslate,
+    this.detectedLanguageCode,
+    this.userPreferredLanguageCode,
+    this.requestedFromLanguage,
+    this.requestedToLanguage,
+    this.translationErrorName,
+    this.displayError,
+  });
+
+  factory TranslationState.$default() => TranslationState(
+    isTranslated: false,
+    isTranslateProcessing: false,
+    isOfferTranslate: false,
+    isExpectedTranslate: false,
+  );
+
+  factory TranslationState.fromData(TabTranslationStateData data) =>
+      TranslationState(
+        isTranslated: data.isTranslated,
+        isTranslateProcessing: data.isTranslateProcessing,
+        isOfferTranslate: data.isOfferTranslate,
+        isExpectedTranslate: data.isExpectedTranslate,
+        detectedLanguageCode: data.detectedLanguageCode,
+        userPreferredLanguageCode: data.userPreferredLanguageCode,
+        requestedFromLanguage: data.requestedFromLanguage,
+        requestedToLanguage: data.requestedToLanguage,
+        translationErrorName: data.translationErrorName,
+        displayError: data.displayError,
+      );
+
+  bool get hasError =>
+      translationErrorName != null && (displayError ?? true);
+
+  @override
+  List<Object?> get hashParameters => [
+    isTranslated,
+    isTranslateProcessing,
+    isOfferTranslate,
+    isExpectedTranslate,
+    detectedLanguageCode,
+    userPreferredLanguageCode,
+    requestedFromLanguage,
+    requestedToLanguage,
+    translationErrorName,
+    displayError,
+  ];
+}
@@ -239,6 +239,27 @@ Stream<MlProgressData> mlProgressEvents(Ref ref) {
  return service.mlProgressEvents;
 }

+/// Translation engine state (browser-level: supported languages, engine availability)
+@Riverpod(keepAlive: true)
+class TranslationEngineState extends _$TranslationEngineState {
+  @override
+  TranslationEngineStateData? build() {
+    final eventService = ref.watch(eventServiceProvider);
+
+    final sub = eventService.translationEngineEvents.listen((value) {
+      if (ref.mounted) {
+        state = value;
+      }
+    });
+
+    ref.onDispose(() async {
+      await sub.cancel();
+    });
+
+    return eventService.translationEngineEvents.valueOrNull;
+  }
+}
+
 /// Tracks active ML model downloads
@Riverpod()
 class MlDownloadState extends _$MlDownloadState {
@@ -389,6 +389,72 @@ final class MlProgressEventsProvider

 String _$mlProgressEventsHash() => r'41c1e6aece7f9ee2bebe5d189c6bec753c2fefc8';

+/// Translation engine state (browser-level: supported languages, engine availability)
+
+@ProviderFor(TranslationEngineState)
+final translationEngineStateProvider = TranslationEngineStateProvider._();
+
+/// Translation engine state (browser-level: supported languages, engine availability)
+final class TranslationEngineStateProvider
+    extends
+        $NotifierProvider<TranslationEngineState, TranslationEngineStateData?> {
+  /// Translation engine state (browser-level: supported languages, engine availability)
+  TranslationEngineStateProvider._()
+    : super(
+        from: null,
+        argument: null,
+        retry: null,
+        name: r'translationEngineStateProvider',
+        isAutoDispose: false,
+        dependencies: null,
+        $allTransitiveDependencies: null,
+      );
+
+  @override
+  String debugGetCreateSourceHash() => _$translationEngineStateHash();
+
+  @$internal
+  @override
+  TranslationEngineState create() => TranslationEngineState();
+
+  /// {@macro riverpod.override_with_value}
+  Override overrideWithValue(TranslationEngineStateData? value) {
+    return $ProviderOverride(
+      origin: this,
+      providerOverride: $SyncValueProvider<TranslationEngineStateData?>(value),
+    );
+  }
+}
+
+String _$translationEngineStateHash() =>
+    r'04592e18715b0e237e9bc027287a880a4bb023da';
+
+/// Translation engine state (browser-level: supported languages, engine availability)
+
+abstract class _$TranslationEngineState
+    extends $Notifier<TranslationEngineStateData?> {
+  TranslationEngineStateData? build();
+  @$mustCallSuper
+  @override
+  void runBuild() {
+    final ref =
+        this.ref
+            as $Ref<TranslationEngineStateData?, TranslationEngineStateData?>;
+    final element =
+        ref.element
+            as $ClassProviderElement<
+              AnyNotifier<
+                TranslationEngineStateData?,
+                TranslationEngineStateData?
+              >,
+              TranslationEngineStateData?,
+              Object?,
+              Object?
+            >;
+    element.handleCreate(ref, build);
+  }
+}
+
 /// Tracks active ML model downloads

@ProviderFor(MlDownloadState)
@@ -76,6 +76,26 @@ class TabSession extends _$TabSession {
    return _sessionService.saveToPdf();
  }

+  Future<void> printContent() {
+    return _sessionService.printContent();
+  }
+
+  Future<void> translate({
+    required String fromLanguage,
+    required String toLanguage,
+    bool? downloadModel,
+  }) {
+    return _sessionService.translate(
+      fromLanguage: fromLanguage,
+      toLanguage: toLanguage,
+      options: TranslationOptions(downloadModel: downloadModel ?? true),
+    );
+  }
+
+  Future<void> translateRestore() {
+    return _sessionService.translateRestore();
+  }
+
  @override
  void build({required String? tabId}) {
    _sessionService = (tabId != null)
@@ -57,7 +57,7 @@ final class TabSessionProvider extends $NotifierProvider<TabSession, void> {
  }
 }

-String _$tabSessionHash() => r'5be471574bb868889cc1eee37ae7e4570a9e21a4';
+String _$tabSessionHash() => r'b9381c334672fd3f733a4cc86ce696fb7de6fa5d';

 final class TabSessionFamily extends $Family
    with $ClassFamilyOverride<TabSession, void, void, void, String?> {
@@ -31,6 +31,7 @@ import 'package:weblibre/features/geckoview/domain/entities/states/history.dart'
 import 'package:weblibre/features/geckoview/domain/entities/states/readerable.dart';
 import 'package:weblibre/features/geckoview/domain/entities/states/security.dart';
 import 'package:weblibre/features/geckoview/domain/entities/states/tab.dart';
+import 'package:weblibre/features/geckoview/domain/entities/states/translation.dart';
 import 'package:weblibre/features/geckoview/domain/providers.dart';
 import 'package:weblibre/features/geckoview/domain/providers/selected_tab.dart';
 import 'package:weblibre/features/geckoview/features/find_in_page/domain/repositories/find_in_page.dart';
@@ -203,6 +204,16 @@ class TabStates extends _$TabStates {
      );
  }

+  void _onTabTranslationStateChange(TabTranslationEvent event) {
+    final TabTranslationEvent(:tabId, :state) = event;
+
+    final current = this.state[tabId] ?? TabState.$default(tabId);
+    this.state = {...this.state}
+      ..[tabId] = current.copyWith.translationState(
+        TranslationState.fromData(state),
+      );
+  }
+
  void _onFindResultsChange(FindResultsEvent event) {
    final FindResultsEvent(:tabId, :results) = event;
    final current = state[tabId] ?? TabState.$default(tabId);
@@ -317,6 +328,18 @@ class TabStates extends _$TabStates {
              );
            },
          ),
+      eventService.tabTranslationEvents.listen(
+        (event) {
+          _onTabTranslationStateChange(event);
+        },
+        onError: (Object error, StackTrace stackTrace) {
+          logger.e(
+            'Error in tab translation events',
+            error: error,
+            stackTrace: stackTrace,
+          );
+        },
+      ),
    ];

    ref.listen(
@@ -331,6 +354,7 @@ class TabStates extends _$TabStates {
            onSecurityInfoStateChange: true,
            onHistoryStateChange: true,
            onFindResults: true,
+            onTranslationStateChange: true,
          );
        }
      },
@@ -41,7 +41,7 @@ final class TabStatesProvider
  }
 }

-String _$tabStatesHash() => r'0fd97193ff963006e1943436b25b025dd3885c65';
+String _$tabStatesHash() => r'6fc9a91b1343f9ae0b442100bed20e42448afa37';

 abstract class _$TabStates extends $Notifier<Map<String, TabState>> {
  Map<String, TabState> build();