Feat: Image favorites (#126)

* feat: 增加图片收藏

* feat: 主体图片收藏页面实现

* feat: 点击打开大图浏览

* feat: 数据结构变更

* feat: 基本完成

* feat: 翻译与bug修复

* feat: 实机测试和问题修复

* feat: jm导入, pica历史记录nhentai有问题, 一键反转

* fix: 大小写不一致, 一个htManga, 一个htmanga

* feat: 拉取收藏优化

* feat: 改成以ep为准

* feat: 兜底一些可能报错场景

* chore: 没有用到

* feat: 尽量保证和网络收藏顺序一致

* feat: 支持显示热点tag

* feat: 支持双击收藏, 不过此时禁止放大图片

* fix: 自动塞封面逻辑完善, 切换快速收藏图片立刻生效

* Refactor

* fix updateValue

* feat: 双击功能提示

* fix: 被确定取消收藏的才删除

* Refactor ImageFavoritesPage

* translate author

* feat: 功能提示改到dialog中

* fix text editing

* fix text editing

* feat: 功能提示放到邮件或长按菜单中

* fix: 修复tag过滤不生效问题

* Improve image loading

* The default value of quickCollectImage should be false.

* Refactor DragListener

* Refactor ImageFavoriteItem & ImageFavoritePhotoView

* Refactor

* Fix `ImageFavoriteManager.has`

* Fix UI

* Improve UI

---------

Co-authored-by: nyne <me@nyne.dev>

lib/foundation/image_provider/base_image_provider.dart

@@ -6,6 +6,7 @@ import 'dart:ui';
 import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 import 'package:venera/foundation/cache_manager.dart';
+import 'package:venera/foundation/log.dart';
 
 abstract class BaseImageProvider<T extends BaseImageProvider<T>>
     extends ImageProvider<T> {
@@ -126,10 +127,11 @@ abstract class BaseImageProvider<T extends BaseImageProvider<T>>
         }
         rethrow;
       }
-    } catch (e) {
+    } catch (e, s) {
       scheduleMicrotask(() {
         PaintingBinding.instance.imageCache.evict(key);
       });
+      Log.error("Image Loading", e, s);
       rethrow;
     } finally {
       chunkEvents.close();

lib/foundation/image_provider/image_favorites_provider.dart

@@ -0,0 +1,146 @@
+import 'dart:async' show Future, StreamController;
+import 'dart:io';
+import 'package:crypto/crypto.dart';
+import 'package:flutter/foundation.dart';
+import 'package:flutter/material.dart';
+import 'package:venera/foundation/app.dart';
+import 'package:venera/foundation/comic_source/comic_source.dart';
+import 'package:venera/foundation/comic_type.dart';
+import 'package:venera/foundation/local.dart';
+import 'package:venera/network/images.dart';
+import 'package:venera/utils/io.dart';
+import '../history.dart';
+import 'base_image_provider.dart';
+import 'image_favorites_provider.dart' as image_provider;
+
+class ImageFavoritesProvider
+    extends BaseImageProvider<image_provider.ImageFavoritesProvider> {
+  /// Image provider for imageFavorites
+  const ImageFavoritesProvider(this.imageFavorite);
+
+  final ImageFavorite imageFavorite;
+
+  int get page => imageFavorite.page;
+
+  String get sourceKey => imageFavorite.sourceKey;
+
+  String get cid => imageFavorite.id;
+
+  String get eid => imageFavorite.eid;
+
+  @override
+  Future<Uint8List> load(StreamController<ImageChunkEvent>? chunkEvents) async {
+    var imageKey = imageFavorite.imageKey;
+    var localImage = await getImageFromLocal();
+    if (localImage != null) {
+      return localImage;
+    }
+    var cacheImage = await readFromCache();
+    if (cacheImage != null) {
+      return cacheImage;
+    }
+    var gotImageKey = false;
+    if (imageKey == "") {
+      imageKey = await getImageKey();
+      gotImageKey = true;
+    }
+    Uint8List image;
+    try {
+      image = await getImageFromNetwork(imageKey, chunkEvents);
+    } catch (e) {
+      if (gotImageKey) {
+        rethrow;
+      } else {
+        imageKey = await getImageKey();
+        image = await getImageFromNetwork(imageKey, chunkEvents);
+      }
+    }
+    await writeToCache(image);
+    return image;
+  }
+
+  Future<void> writeToCache(Uint8List image) async {
+    var fileName = md5.convert(key.codeUnits).toString();
+    var file = File(FilePath.join(App.cachePath, 'image_favorites', fileName));
+    if (!file.existsSync()) {
+      file.createSync(recursive: true);
+    }
+    await file.writeAsBytes(image);
+  }
+
+  Future<Uint8List?> readFromCache() async {
+    var fileName = md5.convert(key.codeUnits).toString();
+    var file = File(FilePath.join(App.cachePath, 'image_favorites', fileName));
+    if (!file.existsSync()) {
+      return null;
+    }
+    return await file.readAsBytes();
+  }
+
+  /// Delete a image favorite cache
+  static Future<void> deleteFromCache(ImageFavorite imageFavorite) async {
+    var fileName = md5.convert(imageFavorite.imageKey.codeUnits).toString();
+    var file = File(FilePath.join(App.cachePath, 'image_favorites', fileName));
+    if (file.existsSync()) {
+      await file.delete();
+    }
+  }
+
+  Future<Uint8List?> getImageFromLocal() async {
+    var localComic =
+        LocalManager().find(sourceKey, ComicType.fromKey(sourceKey));
+    if (localComic == null) {
+      return null;
+    }
+    var epIndex = localComic.chapters?.keys.toList().indexOf(eid) ?? -1;
+    if (epIndex == -1 && localComic.hasChapters) {
+      return null;
+    }
+    var images = await LocalManager().getImages(
+      sourceKey,
+      ComicType.fromKey(sourceKey),
+      epIndex,
+    );
+    var data = await File(images[page]).readAsBytes();
+    return data;
+  }
+
+  Future<Uint8List> getImageFromNetwork(
+      String imageKey, StreamController<ImageChunkEvent>? chunkEvents) async {
+    await for (var progress
+        in ImageDownloader.loadComicImage(imageKey, sourceKey, cid, eid)) {
+      if (chunkEvents != null) {
+        chunkEvents.add(ImageChunkEvent(
+          cumulativeBytesLoaded: progress.currentBytes,
+          expectedTotalBytes: progress.totalBytes,
+        ));
+      }
+      if (progress.imageBytes != null) {
+        return progress.imageBytes!;
+      }
+    }
+    throw "Error: Empty response body.";
+  }
+
+  Future<String> getImageKey() async {
+    String sourceKey = imageFavorite.sourceKey;
+    String cid = imageFavorite.id;
+    String eid = imageFavorite.eid;
+    var page = imageFavorite.page;
+    var comicSource = ComicSource.find(sourceKey);
+    if (comicSource == null) {
+      throw "Error: Comic source not found.";
+    }
+    var res = await comicSource.loadComicPages!(cid, eid);
+    return res.data[page - 1];
+  }
+
+  @override
+  Future<ImageFavoritesProvider> obtainKey(ImageConfiguration configuration) {
+    return SynchronousFuture(this);
+  }
+
+  @override
+  String get key =>
+      "ImageFavorites ${imageFavorite.imageKey}@${imageFavorite.sourceKey}@${imageFavorite.id}@${imageFavorite.eid}";
+}

lib/foundation/image_provider/local_favorite_image.dart

@@ -22,7 +22,7 @@ class LocalFavoriteImageProvider
   static void delete(String id, int intKey) {
     var fileName = (id + intKey.toString()).hashCode.toString();
     var file = File(FilePath.join(App.dataPath, 'favorite_cover', fileName));
-    if(file.existsSync()) {
+    if (file.existsSync()) {
       file.delete();
     }
   }
@@ -42,7 +42,7 @@ class LocalFavoriteImageProvider
         cumulativeBytesLoaded: progress.currentBytes,
         expectedTotalBytes: progress.totalBytes,
       ));
-      if(progress.imageBytes != null) {
+      if (progress.imageBytes != null) {
         var data = progress.imageBytes!;
         await file.writeAsBytes(data);
         return data;
@@ -52,7 +52,8 @@ class LocalFavoriteImageProvider
   }
 
   @override
-  Future<LocalFavoriteImageProvider> obtainKey(ImageConfiguration configuration) {
+  Future<LocalFavoriteImageProvider> obtainKey(
+      ImageConfiguration configuration) {
     return SynchronousFuture(this);
   }