thumbnail_util.dart 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201
  1. import 'dart:async';
  2. import 'dart:collection';
  3. import 'dart:io' as io;
  4. import 'dart:typed_data';
  5. import 'package:dio/dio.dart';
  6. import 'package:logging/logging.dart';
  7. import 'package:photo_manager/photo_manager.dart';
  8. import 'package:photos/core/cache/thumbnail_in_memory_cache.dart';
  9. import 'package:photos/core/configuration.dart';
  10. import 'package:photos/core/constants.dart';
  11. import 'package:photos/core/errors.dart';
  12. import 'package:photos/core/network/network.dart';
  13. import 'package:photos/models/file.dart';
  14. import 'package:photos/utils/crypto_util.dart';
  15. import 'package:photos/utils/file_download_util.dart';
  16. import 'package:photos/utils/file_uploader_util.dart';
  17. import 'package:photos/utils/file_util.dart';
  18. final _logger = Logger("ThumbnailUtil");
  19. final _uploadIDToDownloadItem = <int, FileDownloadItem>{};
  20. final _downloadQueue = Queue<int>();
  21. const int kMaximumConcurrentDownloads = 500;
  22. class FileDownloadItem {
  23. final File file;
  24. final Completer<Uint8List> completer;
  25. final CancelToken cancelToken;
  26. int counter = 0; // number of times file download was requested
  27. FileDownloadItem(this.file, this.completer, this.cancelToken, this.counter);
  28. }
  29. Future<Uint8List?> getThumbnail(File file) async {
  30. if (file.isRemoteFile) {
  31. return getThumbnailFromServer(file);
  32. } else {
  33. return getThumbnailFromLocal(
  34. file,
  35. size: thumbnailLargeSize,
  36. );
  37. }
  38. }
  39. Future<Uint8List> getThumbnailFromServer(File file) async {
  40. final cachedThumbnail = cachedThumbnailPath(file);
  41. if (await cachedThumbnail.exists()) {
  42. final data = await cachedThumbnail.readAsBytes();
  43. ThumbnailInMemoryLruCache.put(file, data);
  44. return data;
  45. }
  46. // Check if there's already in flight request for fetching thumbnail from the
  47. // server
  48. if (!_uploadIDToDownloadItem.containsKey(file.uploadedFileID)) {
  49. final item =
  50. FileDownloadItem(file, Completer<Uint8List>(), CancelToken(), 1);
  51. _uploadIDToDownloadItem[file.uploadedFileID!] = item;
  52. if (_downloadQueue.length > kMaximumConcurrentDownloads) {
  53. final id = _downloadQueue.removeFirst();
  54. final FileDownloadItem item = _uploadIDToDownloadItem.remove(id)!;
  55. item.cancelToken.cancel();
  56. item.completer.completeError(RequestCancelledError());
  57. }
  58. _downloadQueue.add(file.uploadedFileID!);
  59. _downloadItem(item);
  60. return item.completer.future;
  61. } else {
  62. _uploadIDToDownloadItem[file.uploadedFileID]!.counter++;
  63. return _uploadIDToDownloadItem[file.uploadedFileID]!.completer.future;
  64. }
  65. }
  66. Future<Uint8List?> getThumbnailFromLocal(
  67. File file, {
  68. int size = thumbnailSmallSize,
  69. int quality = thumbnailQuality,
  70. }) async {
  71. final lruCachedThumbnail = ThumbnailInMemoryLruCache.get(file, size);
  72. if (lruCachedThumbnail != null) {
  73. return lruCachedThumbnail;
  74. }
  75. final cachedThumbnail = cachedThumbnailPath(file);
  76. if ((await cachedThumbnail.exists())) {
  77. final data = await cachedThumbnail.readAsBytes();
  78. ThumbnailInMemoryLruCache.put(file, data);
  79. return data;
  80. }
  81. if (file.isSharedMediaToAppSandbox) {
  82. //todo:neeraj support specifying size/quality
  83. return getThumbnailFromInAppCacheFile(file).then((data) {
  84. if (data != null) {
  85. ThumbnailInMemoryLruCache.put(file, data, size);
  86. }
  87. return data;
  88. });
  89. } else {
  90. return file.getAsset.then((asset) async {
  91. if (asset == null || !(await asset.exists)) {
  92. return null;
  93. }
  94. return asset
  95. .thumbnailDataWithSize(ThumbnailSize(size, size), quality: quality)
  96. .then((data) {
  97. ThumbnailInMemoryLruCache.put(file, data, size);
  98. return data;
  99. });
  100. });
  101. }
  102. }
  103. void removePendingGetThumbnailRequestIfAny(File file) {
  104. if (_uploadIDToDownloadItem.containsKey(file.uploadedFileID)) {
  105. final item = _uploadIDToDownloadItem[file.uploadedFileID]!;
  106. item.counter--;
  107. if (item.counter <= 0) {
  108. _uploadIDToDownloadItem.remove(file.uploadedFileID);
  109. item.cancelToken.cancel();
  110. _downloadQueue.removeWhere((element) => element == file.uploadedFileID);
  111. }
  112. }
  113. }
  114. void _downloadItem(FileDownloadItem item) async {
  115. try {
  116. await _downloadAndDecryptThumbnail(item);
  117. } catch (e, s) {
  118. _logger.severe(
  119. "Failed to download thumbnail " + item.file.toString(),
  120. e,
  121. s,
  122. );
  123. item.completer.completeError(e);
  124. }
  125. _downloadQueue.removeWhere((element) => element == item.file.uploadedFileID);
  126. _uploadIDToDownloadItem.remove(item.file.uploadedFileID);
  127. }
  128. Future<void> _downloadAndDecryptThumbnail(FileDownloadItem item) async {
  129. final file = item.file;
  130. Uint8List encryptedThumbnail;
  131. try {
  132. encryptedThumbnail = (await NetworkClient.instance.getDio().get(
  133. file.thumbnailUrl,
  134. options: Options(
  135. headers: {"X-Auth-Token": Configuration.instance.getToken()},
  136. responseType: ResponseType.bytes,
  137. ),
  138. cancelToken: item.cancelToken,
  139. ))
  140. .data;
  141. } catch (e) {
  142. if (e is DioError && CancelToken.isCancel(e)) {
  143. return;
  144. }
  145. rethrow;
  146. }
  147. if (!_uploadIDToDownloadItem.containsKey(file.uploadedFileID)) {
  148. return;
  149. }
  150. final thumbnailDecryptionKey = await getFileKeyUsingBgWorker(file);
  151. Uint8List data;
  152. try {
  153. data = await CryptoUtil.decryptChaCha(
  154. encryptedThumbnail,
  155. thumbnailDecryptionKey,
  156. CryptoUtil.base642bin(file.thumbnailDecryptionHeader!),
  157. );
  158. } catch (e, s) {
  159. _logger.severe("Failed to decrypt thumbnail", e, s);
  160. item.completer.completeError(e);
  161. return;
  162. }
  163. final thumbnailSize = data.length;
  164. if (thumbnailSize > thumbnailDataLimit) {
  165. data = await compressThumbnail(data);
  166. }
  167. ThumbnailInMemoryLruCache.put(item.file, data);
  168. final cachedThumbnail = cachedThumbnailPath(item.file);
  169. if (await cachedThumbnail.exists()) {
  170. await cachedThumbnail.delete();
  171. }
  172. // data is already cached in-memory, no need to await on dist write
  173. unawaited(cachedThumbnail.writeAsBytes(data));
  174. if (_uploadIDToDownloadItem.containsKey(file.uploadedFileID)) {
  175. try {
  176. item.completer.complete(data);
  177. } catch (e) {
  178. _logger.severe(
  179. "Error while completing request for " + file.uploadedFileID.toString(),
  180. );
  181. }
  182. }
  183. }
  184. io.File cachedThumbnailPath(File file) {
  185. final thumbnailCacheDirectory =
  186. Configuration.instance.getThumbnailCacheDirectory();
  187. return io.File(
  188. thumbnailCacheDirectory + "/" + file.uploadedFileID.toString(),
  189. );
  190. }