prepare history api

2025-09-17 17:53:06 +02:00
parent d24d612635
commit 9676ccae3d
10 changed files with 850 additions and 209 deletions
@@ -17,6 +17,7 @@ export 'src/domain/services/gecko_downloads.dart';
 export 'src/domain/services/gecko_engine_settings.dart';
 export 'src/domain/services/gecko_event.dart';
 export 'src/domain/services/gecko_find_in_page.dart';
+export 'src/domain/services/gecko_history.dart';
 export 'src/domain/services/gecko_icon.dart';
 export 'src/domain/services/gecko_logging.dart';
 export 'src/domain/services/gecko_ml.dart';
@@ -59,6 +60,8 @@ export 'src/pigeons/gecko.g.dart'
        TrackingProtectionPolicy,
        UnknownHitResult,
        VideoHitResult,
+        VisitInfo,
+        VisitType,
        WebContentIsolationStrategy,
        WebExtensionActionType,
        WebExtensionData;
@@ -0,0 +1,27 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
+import 'package:flutter_mozilla_components/src/pigeons/gecko.g.dart';
+
+final _apiInstance = GeckoHistoryApi();
+
+class GeckoHistoryService {
+  final GeckoHistoryApi _api;
+
+  GeckoHistoryService({GeckoHistoryApi? api}) : _api = api ?? _apiInstance;
+
+  Future<List<VisitInfo>> getDetailedVisits(
+    DateTime start,
+    DateTime end,
+    Set<VisitType> types,
+  ) {
+    return _api.getDetailedVisits(
+      start.millisecondsSinceEpoch,
+      end.millisecondsSinceEpoch,
+      VisitType.values.toSet().difference(types).toList(),
+    );
+  }
+}
@@ -92,6 +92,18 @@ enum CookieSameSiteStatus {
  unspecified,
 }

+enum VisitType {
+  link,
+  typed,
+  bookmark,
+  embed,
+  redirectPermanent,
+  redirectTemporary,
+  download,
+  framedLink,
+  reload,
+}
+
 enum SelectionPattern {
  phone,
  email,
@@ -1222,6 +1234,72 @@ class Cookie {
 ;
 }

+class VisitInfo {
+  VisitInfo({
+    required this.url,
+    this.title,
+    required this.visitTime,
+    required this.visitType,
+    this.previewImageUrl,
+    required this.isRemote,
+  });
+
+  String url;
+
+  String? title;
+
+  int visitTime;
+
+  VisitType visitType;
+
+  String? previewImageUrl;
+
+  bool isRemote;
+
+  List<Object?> _toList() {
+    return <Object?>[
+      url,
+      title,
+      visitTime,
+      visitType,
+      previewImageUrl,
+      isRemote,
+    ];
+  }
+
+  Object encode() {
+    return _toList();  }
+
+  static VisitInfo decode(Object result) {
+    result as List<Object?>;
+    return VisitInfo(
+      url: result[0]! as String,
+      title: result[1] as String?,
+      visitTime: result[2]! as int,
+      visitType: result[3]! as VisitType,
+      previewImageUrl: result[4] as String?,
+      isRemote: result[5]! as bool,
+    );
+  }
+
+  @override
+  // ignore: avoid_equals_and_hash_code_on_mutable_classes
+  bool operator ==(Object other) {
+    if (other is! VisitInfo || other.runtimeType != runtimeType) {
+      return false;
+    }
+    if (identical(this, other)) {
+      return true;
+    }
+    return _deepEquals(encode(), other.encode());
+  }
+
+  @override
+  // ignore: avoid_equals_and_hash_code_on_mutable_classes
+  int get hashCode => Object.hashAll(_toList())
+;
+}
+
 class HistoryItem {
  HistoryItem({
    required this.url,
@@ -2589,162 +2667,168 @@ class _PigeonCodec extends StandardMessageCodec {
    }    else if (value is CookieSameSiteStatus) {
      buffer.putUint8(133);
      writeValue(buffer, value.index);
-    }    else if (value is SelectionPattern) {
+    }    else if (value is VisitType) {
      buffer.putUint8(134);
      writeValue(buffer, value.index);
-    }    else if (value is WebExtensionActionType) {
+    }    else if (value is SelectionPattern) {
      buffer.putUint8(135);
      writeValue(buffer, value.index);
-    }    else if (value is GeckoSuggestionType) {
+    }    else if (value is WebExtensionActionType) {
      buffer.putUint8(136);
      writeValue(buffer, value.index);
-    }    else if (value is TrackingProtectionPolicy) {
+    }    else if (value is GeckoSuggestionType) {
      buffer.putUint8(137);
      writeValue(buffer, value.index);
-    }    else if (value is HttpsOnlyMode) {
+    }    else if (value is TrackingProtectionPolicy) {
      buffer.putUint8(138);
      writeValue(buffer, value.index);
-    }    else if (value is QueryParameterStripping) {
+    }    else if (value is HttpsOnlyMode) {
      buffer.putUint8(139);
      writeValue(buffer, value.index);
-    }    else if (value is BounceTrackingProtectionMode) {
+    }    else if (value is QueryParameterStripping) {
      buffer.putUint8(140);
      writeValue(buffer, value.index);
-    }    else if (value is ColorScheme) {
+    }    else if (value is BounceTrackingProtectionMode) {
      buffer.putUint8(141);
      writeValue(buffer, value.index);
-    }    else if (value is CookieBannerHandlingMode) {
+    }    else if (value is ColorScheme) {
      buffer.putUint8(142);
      writeValue(buffer, value.index);
-    }    else if (value is WebContentIsolationStrategy) {
+    }    else if (value is CookieBannerHandlingMode) {
      buffer.putUint8(143);
      writeValue(buffer, value.index);
-    }    else if (value is DownloadStatus) {
+    }    else if (value is WebContentIsolationStrategy) {
      buffer.putUint8(144);
      writeValue(buffer, value.index);
-    }    else if (value is LogLevel) {
+    }    else if (value is DownloadStatus) {
      buffer.putUint8(145);
      writeValue(buffer, value.index);
-    }    else if (value is TranslationOptions) {
+    }    else if (value is LogLevel) {
      buffer.putUint8(146);
-      writeValue(buffer, value.encode());
-    }    else if (value is ReaderState) {
+      writeValue(buffer, value.index);
+    }    else if (value is TranslationOptions) {
      buffer.putUint8(147);
      writeValue(buffer, value.encode());
-    }    else if (value is LastMediaAccessState) {
+    }    else if (value is ReaderState) {
      buffer.putUint8(148);
      writeValue(buffer, value.encode());
-    }    else if (value is HistoryMetadataKey) {
+    }    else if (value is LastMediaAccessState) {
      buffer.putUint8(149);
      writeValue(buffer, value.encode());
-    }    else if (value is PackageCategoryValue) {
+    }    else if (value is HistoryMetadataKey) {
      buffer.putUint8(150);
      writeValue(buffer, value.encode());
-    }    else if (value is ExternalPackage) {
+    }    else if (value is PackageCategoryValue) {
      buffer.putUint8(151);
      writeValue(buffer, value.encode());
-    }    else if (value is LoadUrlFlagsValue) {
+    }    else if (value is ExternalPackage) {
      buffer.putUint8(152);
      writeValue(buffer, value.encode());
-    }    else if (value is SourceValue) {
+    }    else if (value is LoadUrlFlagsValue) {
      buffer.putUint8(153);
      writeValue(buffer, value.encode());
-    }    else if (value is TabState) {
+    }    else if (value is SourceValue) {
      buffer.putUint8(154);
      writeValue(buffer, value.encode());
-    }    else if (value is RecoverableTab) {
+    }    else if (value is TabState) {
      buffer.putUint8(155);
      writeValue(buffer, value.encode());
-    }    else if (value is RecoverableBrowserState) {
+    }    else if (value is RecoverableTab) {
      buffer.putUint8(156);
      writeValue(buffer, value.encode());
-    }    else if (value is IconRequest) {
+    }    else if (value is RecoverableBrowserState) {
      buffer.putUint8(157);
      writeValue(buffer, value.encode());
-    }    else if (value is ResourceSize) {
+    }    else if (value is IconRequest) {
      buffer.putUint8(158);
      writeValue(buffer, value.encode());
-    }    else if (value is Resource) {
+    }    else if (value is ResourceSize) {
      buffer.putUint8(159);
      writeValue(buffer, value.encode());
-    }    else if (value is IconResult) {
+    }    else if (value is Resource) {
      buffer.putUint8(160);
      writeValue(buffer, value.encode());
-    }    else if (value is CookiePartitionKey) {
+    }    else if (value is IconResult) {
      buffer.putUint8(161);
      writeValue(buffer, value.encode());
-    }    else if (value is Cookie) {
+    }    else if (value is CookiePartitionKey) {
      buffer.putUint8(162);
      writeValue(buffer, value.encode());
-    }    else if (value is HistoryItem) {
+    }    else if (value is Cookie) {
      buffer.putUint8(163);
      writeValue(buffer, value.encode());
-    }    else if (value is HistoryState) {
+    }    else if (value is VisitInfo) {
      buffer.putUint8(164);
      writeValue(buffer, value.encode());
-    }    else if (value is ReaderableState) {
+    }    else if (value is HistoryItem) {
      buffer.putUint8(165);
      writeValue(buffer, value.encode());
-    }    else if (value is SecurityInfoState) {
+    }    else if (value is HistoryState) {
      buffer.putUint8(166);
      writeValue(buffer, value.encode());
-    }    else if (value is TabContentState) {
+    }    else if (value is ReaderableState) {
      buffer.putUint8(167);
      writeValue(buffer, value.encode());
-    }    else if (value is FindResultState) {
+    }    else if (value is SecurityInfoState) {
      buffer.putUint8(168);
      writeValue(buffer, value.encode());
-    }    else if (value is CustomSelectionAction) {
+    }    else if (value is TabContentState) {
      buffer.putUint8(169);
      writeValue(buffer, value.encode());
-    }    else if (value is WebExtensionData) {
+    }    else if (value is FindResultState) {
      buffer.putUint8(170);
      writeValue(buffer, value.encode());
-    }    else if (value is GeckoSuggestion) {
+    }    else if (value is CustomSelectionAction) {
      buffer.putUint8(171);
      writeValue(buffer, value.encode());
-    }    else if (value is TabContent) {
+    }    else if (value is WebExtensionData) {
      buffer.putUint8(172);
      writeValue(buffer, value.encode());
-    }    else if (value is ContentBlocking) {
+    }    else if (value is GeckoSuggestion) {
      buffer.putUint8(173);
      writeValue(buffer, value.encode());
-    }    else if (value is GeckoEngineSettings) {
+    }    else if (value is TabContent) {
      buffer.putUint8(174);
      writeValue(buffer, value.encode());
-    }    else if (value is AutocompleteResult) {
+    }    else if (value is ContentBlocking) {
      buffer.putUint8(175);
      writeValue(buffer, value.encode());
-    }    else if (value is UnknownHitResult) {
+    }    else if (value is GeckoEngineSettings) {
      buffer.putUint8(176);
      writeValue(buffer, value.encode());
-    }    else if (value is ImageHitResult) {
+    }    else if (value is AutocompleteResult) {
      buffer.putUint8(177);
      writeValue(buffer, value.encode());
-    }    else if (value is VideoHitResult) {
+    }    else if (value is UnknownHitResult) {
      buffer.putUint8(178);
      writeValue(buffer, value.encode());
-    }    else if (value is AudioHitResult) {
+    }    else if (value is ImageHitResult) {
      buffer.putUint8(179);
      writeValue(buffer, value.encode());
-    }    else if (value is ImageSrcHitResult) {
+    }    else if (value is VideoHitResult) {
      buffer.putUint8(180);
      writeValue(buffer, value.encode());
-    }    else if (value is PhoneHitResult) {
+    }    else if (value is AudioHitResult) {
      buffer.putUint8(181);
      writeValue(buffer, value.encode());
-    }    else if (value is EmailHitResult) {
+    }    else if (value is ImageSrcHitResult) {
      buffer.putUint8(182);
      writeValue(buffer, value.encode());
-    }    else if (value is GeoHitResult) {
+    }    else if (value is PhoneHitResult) {
      buffer.putUint8(183);
      writeValue(buffer, value.encode());
-    }    else if (value is DownloadState) {
+    }    else if (value is EmailHitResult) {
      buffer.putUint8(184);
      writeValue(buffer, value.encode());
-    }    else if (value is ShareInternetResourceState) {
+    }    else if (value is GeoHitResult) {
      buffer.putUint8(185);
      writeValue(buffer, value.encode());
+    }    else if (value is DownloadState) {
+      buffer.putUint8(186);
+      writeValue(buffer, value.encode());
+    }    else if (value is ShareInternetResourceState) {
+      buffer.putUint8(187);
+      writeValue(buffer, value.encode());
    } else {
      super.writeValue(buffer, value);
    }
@@ -2770,119 +2854,124 @@ class _PigeonCodec extends StandardMessageCodec {
        return value == null ? null : CookieSameSiteStatus.values[value];
      case 134: 
        final int? value = readValue(buffer) as int?;
-        return value == null ? null : SelectionPattern.values[value];
+        return value == null ? null : VisitType.values[value];
      case 135: 
        final int? value = readValue(buffer) as int?;
-        return value == null ? null : WebExtensionActionType.values[value];
+        return value == null ? null : SelectionPattern.values[value];
      case 136: 
        final int? value = readValue(buffer) as int?;
-        return value == null ? null : GeckoSuggestionType.values[value];
+        return value == null ? null : WebExtensionActionType.values[value];
      case 137: 
        final int? value = readValue(buffer) as int?;
-        return value == null ? null : TrackingProtectionPolicy.values[value];
+        return value == null ? null : GeckoSuggestionType.values[value];
      case 138: 
        final int? value = readValue(buffer) as int?;
-        return value == null ? null : HttpsOnlyMode.values[value];
+        return value == null ? null : TrackingProtectionPolicy.values[value];
      case 139: 
        final int? value = readValue(buffer) as int?;
-        return value == null ? null : QueryParameterStripping.values[value];
+        return value == null ? null : HttpsOnlyMode.values[value];
      case 140: 
        final int? value = readValue(buffer) as int?;
-        return value == null ? null : BounceTrackingProtectionMode.values[value];
+        return value == null ? null : QueryParameterStripping.values[value];
      case 141: 
        final int? value = readValue(buffer) as int?;
-        return value == null ? null : ColorScheme.values[value];
+        return value == null ? null : BounceTrackingProtectionMode.values[value];
      case 142: 
        final int? value = readValue(buffer) as int?;
-        return value == null ? null : CookieBannerHandlingMode.values[value];
+        return value == null ? null : ColorScheme.values[value];
      case 143: 
        final int? value = readValue(buffer) as int?;
-        return value == null ? null : WebContentIsolationStrategy.values[value];
+        return value == null ? null : CookieBannerHandlingMode.values[value];
      case 144: 
        final int? value = readValue(buffer) as int?;
-        return value == null ? null : DownloadStatus.values[value];
+        return value == null ? null : WebContentIsolationStrategy.values[value];
      case 145: 
        final int? value = readValue(buffer) as int?;
-        return value == null ? null : LogLevel.values[value];
+        return value == null ? null : DownloadStatus.values[value];
      case 146: 
-        return TranslationOptions.decode(readValue(buffer)!);
+        final int? value = readValue(buffer) as int?;
+        return value == null ? null : LogLevel.values[value];
      case 147: 
-        return ReaderState.decode(readValue(buffer)!);
+        return TranslationOptions.decode(readValue(buffer)!);
      case 148: 
-        return LastMediaAccessState.decode(readValue(buffer)!);
+        return ReaderState.decode(readValue(buffer)!);
      case 149: 
-        return HistoryMetadataKey.decode(readValue(buffer)!);
+        return LastMediaAccessState.decode(readValue(buffer)!);
      case 150: 
-        return PackageCategoryValue.decode(readValue(buffer)!);
+        return HistoryMetadataKey.decode(readValue(buffer)!);
      case 151: 
-        return ExternalPackage.decode(readValue(buffer)!);
+        return PackageCategoryValue.decode(readValue(buffer)!);
      case 152: 
-        return LoadUrlFlagsValue.decode(readValue(buffer)!);
+        return ExternalPackage.decode(readValue(buffer)!);
      case 153: 
-        return SourceValue.decode(readValue(buffer)!);
+        return LoadUrlFlagsValue.decode(readValue(buffer)!);
      case 154: 
-        return TabState.decode(readValue(buffer)!);
+        return SourceValue.decode(readValue(buffer)!);
      case 155: 
-        return RecoverableTab.decode(readValue(buffer)!);
+        return TabState.decode(readValue(buffer)!);
      case 156: 
-        return RecoverableBrowserState.decode(readValue(buffer)!);
+        return RecoverableTab.decode(readValue(buffer)!);
      case 157: 
-        return IconRequest.decode(readValue(buffer)!);
+        return RecoverableBrowserState.decode(readValue(buffer)!);
      case 158: 
-        return ResourceSize.decode(readValue(buffer)!);
+        return IconRequest.decode(readValue(buffer)!);
      case 159: 
-        return Resource.decode(readValue(buffer)!);
+        return ResourceSize.decode(readValue(buffer)!);
      case 160: 
-        return IconResult.decode(readValue(buffer)!);
+        return Resource.decode(readValue(buffer)!);
      case 161: 
-        return CookiePartitionKey.decode(readValue(buffer)!);
+        return IconResult.decode(readValue(buffer)!);
      case 162: 
-        return Cookie.decode(readValue(buffer)!);
+        return CookiePartitionKey.decode(readValue(buffer)!);
      case 163: 
-        return HistoryItem.decode(readValue(buffer)!);
+        return Cookie.decode(readValue(buffer)!);
      case 164: 
-        return HistoryState.decode(readValue(buffer)!);
+        return VisitInfo.decode(readValue(buffer)!);
      case 165: 
-        return ReaderableState.decode(readValue(buffer)!);
+        return HistoryItem.decode(readValue(buffer)!);
      case 166: 
-        return SecurityInfoState.decode(readValue(buffer)!);
+        return HistoryState.decode(readValue(buffer)!);
      case 167: 
-        return TabContentState.decode(readValue(buffer)!);
+        return ReaderableState.decode(readValue(buffer)!);
      case 168: 
-        return FindResultState.decode(readValue(buffer)!);
+        return SecurityInfoState.decode(readValue(buffer)!);
      case 169: 
-        return CustomSelectionAction.decode(readValue(buffer)!);
+        return TabContentState.decode(readValue(buffer)!);
      case 170: 
-        return WebExtensionData.decode(readValue(buffer)!);
+        return FindResultState.decode(readValue(buffer)!);
      case 171: 
-        return GeckoSuggestion.decode(readValue(buffer)!);
+        return CustomSelectionAction.decode(readValue(buffer)!);
      case 172: 
-        return TabContent.decode(readValue(buffer)!);
+        return WebExtensionData.decode(readValue(buffer)!);
      case 173: 
-        return ContentBlocking.decode(readValue(buffer)!);
+        return GeckoSuggestion.decode(readValue(buffer)!);
      case 174: 
-        return GeckoEngineSettings.decode(readValue(buffer)!);
+        return TabContent.decode(readValue(buffer)!);
      case 175: 
-        return AutocompleteResult.decode(readValue(buffer)!);
+        return ContentBlocking.decode(readValue(buffer)!);
      case 176: 
-        return UnknownHitResult.decode(readValue(buffer)!);
+        return GeckoEngineSettings.decode(readValue(buffer)!);
      case 177: 
-        return ImageHitResult.decode(readValue(buffer)!);
+        return AutocompleteResult.decode(readValue(buffer)!);
      case 178: 
-        return VideoHitResult.decode(readValue(buffer)!);
+        return UnknownHitResult.decode(readValue(buffer)!);
      case 179: 
-        return AudioHitResult.decode(readValue(buffer)!);
+        return ImageHitResult.decode(readValue(buffer)!);
      case 180: 
-        return ImageSrcHitResult.decode(readValue(buffer)!);
+        return VideoHitResult.decode(readValue(buffer)!);
      case 181: 
-        return PhoneHitResult.decode(readValue(buffer)!);
+        return AudioHitResult.decode(readValue(buffer)!);
      case 182: 
-        return EmailHitResult.decode(readValue(buffer)!);
+        return ImageSrcHitResult.decode(readValue(buffer)!);
      case 183: 
-        return GeoHitResult.decode(readValue(buffer)!);
+        return PhoneHitResult.decode(readValue(buffer)!);
      case 184: 
-        return DownloadState.decode(readValue(buffer)!);
+        return EmailHitResult.decode(readValue(buffer)!);
      case 185: 
+        return GeoHitResult.decode(readValue(buffer)!);
+      case 186: 
+        return DownloadState.decode(readValue(buffer)!);
+      case 187: 
        return ShareInternetResourceState.decode(readValue(buffer)!);
      default:
        return super.readValueOfType(type, buffer);
@@ -5587,6 +5676,48 @@ class GeckoDeleteBrowsingDataController {
  }
 }

+class GeckoHistoryApi {
+  /// Constructor for [GeckoHistoryApi].  The [binaryMessenger] named argument is
+  /// available for dependency injection.  If it is left null, the default
+  /// BinaryMessenger will be used which routes to the host platform.
+  GeckoHistoryApi({BinaryMessenger? binaryMessenger, String messageChannelSuffix = ''})
+      : pigeonVar_binaryMessenger = binaryMessenger,
+        pigeonVar_messageChannelSuffix = messageChannelSuffix.isNotEmpty ? '.$messageChannelSuffix' : '';
+  final BinaryMessenger? pigeonVar_binaryMessenger;
+
+  static const MessageCodec<Object?> pigeonChannelCodec = _PigeonCodec();
+
+  final String pigeonVar_messageChannelSuffix;
+
+  Future<List<VisitInfo>> getDetailedVisits(int startMillis, int endMillis, List<VisitType> excludeTypes) async {
+    final String pigeonVar_channelName = 'dev.flutter.pigeon.flutter_mozilla_components.GeckoHistoryApi.getDetailedVisits$pigeonVar_messageChannelSuffix';
+    final BasicMessageChannel<Object?> pigeonVar_channel = BasicMessageChannel<Object?>(
+      pigeonVar_channelName,
+      pigeonChannelCodec,
+      binaryMessenger: pigeonVar_binaryMessenger,
+    );
+    final Future<Object?> pigeonVar_sendFuture = pigeonVar_channel.send(<Object?>[startMillis, endMillis, excludeTypes]);
+    final List<Object?>? pigeonVar_replyList =
+        await pigeonVar_sendFuture as List<Object?>?;
+    if (pigeonVar_replyList == null) {
+      throw _createConnectionError(pigeonVar_channelName);
+    } else if (pigeonVar_replyList.length > 1) {
+      throw PlatformException(
+        code: pigeonVar_replyList[0]! as String,
+        message: pigeonVar_replyList[1] as String?,
+        details: pigeonVar_replyList[2],
+      );
+    } else if (pigeonVar_replyList[0] == null) {
+      throw PlatformException(
+        code: 'null-error',
+        message: 'Host platform returned null value for non-null return value.',
+      );
+    } else {
+      return (pigeonVar_replyList[0] as List<Object?>?)!.cast<VisitInfo>();
+    }
+  }
+}
+
 class GeckoDownloadsApi {
  /// Constructor for [GeckoDownloadsApi].  The [binaryMessenger] named argument is
  /// available for dependency injection.  If it is left null, the default