Skip to content

armgit / ente

Public Imported from GitHub
0

πŸ’š End-to-end encrypted cloud for everything.

photos: show support dialog for decryption failures

ashilkna3aff9a9d592
diff --git a/mobile/apps/photos/changes/decryption-failure-support-dialog.md b/mobile/apps/photos/changes/decryption-failure-support-dialog.md
new file mode 100644
index 0000000000..65f344458a
--- /dev/null
+++ b/mobile/apps/photos/changes/decryption-failure-support-dialog.md
@@ -0,0 +1 @@
+- Added a support dialog when an item cannot be decrypted in the viewer.
diff --git a/mobile/apps/photos/lib/module/download/decrypt.dart b/mobile/apps/photos/lib/module/download/decrypt.dart
index 5fc269b7c7..a5e444d413 100644
--- a/mobile/apps/photos/lib/module/download/decrypt.dart
+++ b/mobile/apps/photos/lib/module/download/decrypt.dart
@@ -9,6 +9,7 @@ import 'package:photos/core/configuration.dart';
import 'package:photos/core/network/network.dart';
import 'package:photos/models/file/file.dart';
import 'package:photos/models/file/file_type.dart';
+import 'package:photos/module/download/download_error.dart';
import 'package:photos/module/download/file_url.dart';
import 'package:photos/module/download/manager.dart';
import 'package:photos/module/download/task.dart';
@@ -17,28 +18,14 @@ import 'package:photos/services/collections_service.dart';
import 'package:photos/utils/device_storage_error.dart';
import 'package:photos/utils/file_key.dart';
-final _logger = Logger('file_download_util');
-
-class DownloadFailedError implements Exception {
- final String message;
-
- DownloadFailedError(this.message);
+export 'package:photos/module/download/download_error.dart';
- @override
- String toString() => message;
-}
-
-class DownloadNoConnectionError extends DownloadFailedError {
- DownloadNoConnectionError() : super('No connection');
-}
-
-class DownloadUnavailableError extends DownloadFailedError {
- DownloadUnavailableError() : super('Unavailable');
-}
+final _logger = Logger('file_download_util');
Future<File?> _downloadAndDecryptPublicFile(
EnteFile file, {
ProgressCallback? progressCallback,
+ bool throwOnDecryptionFailure = false,
}) async {
final logPrefix = 'Public File-${file.uploadedFileID}:';
_logger.info(
@@ -107,11 +94,17 @@ Future<File?> _downloadAndDecryptPublicFile(
error,
stackTrace,
);
+ if (throwOnDecryptionFailure) {
+ throw DownloadDecryptionFailedError();
+ }
return null;
}
return File(decryptedFilePath);
} catch (error, stackTrace) {
_logger.severe('$logPrefix failed to download', error, stackTrace);
+ if (throwOnDecryptionFailure && error is DownloadDecryptionFailedError) {
+ rethrow;
+ }
return null;
}
}
@@ -121,11 +114,13 @@ Future<File?> downloadAndDecrypt(
ProgressCallback? progressCallback,
bool forceResumableDownload = false,
bool throwOnFailure = false,
+ bool throwOnDecryptionFailure = false,
}) async {
if (CollectionsService.instance.isSharedPublicLink(file.collectionID!)) {
return _downloadAndDecryptPublicFile(
file,
progressCallback: progressCallback,
+ throwOnDecryptionFailure: throwOnDecryptionFailure,
);
}
@@ -224,8 +219,8 @@ Future<File?> downloadAndDecrypt(
error,
stackTrace,
);
- if (throwOnFailure) {
- throw DownloadFailedError('Failed to decrypt downloaded file');
+ if (throwOnFailure || throwOnDecryptionFailure) {
+ throw DownloadDecryptionFailedError();
}
return null;
}
@@ -237,7 +232,8 @@ Future<File?> downloadAndDecrypt(
error,
stackTrace,
);
- if (throwOnFailure) {
+ if (throwOnFailure ||
+ (throwOnDecryptionFailure && error is DownloadDecryptionFailedError)) {
if (error is DownloadFailedError) {
rethrow;
}
diff --git a/mobile/apps/photos/lib/module/download/download_error.dart b/mobile/apps/photos/lib/module/download/download_error.dart
new file mode 100644
index 0000000000..c997641db7
--- /dev/null
+++ b/mobile/apps/photos/lib/module/download/download_error.dart
@@ -0,0 +1,34 @@
+class DownloadFailedError implements Exception {
+ final String message;
+
+ DownloadFailedError(this.message);
+
+ @override
+ String toString() => message;
+}
+
+class DownloadNoConnectionError extends DownloadFailedError {
+ DownloadNoConnectionError() : super('No connection');
+}
+
+class DownloadUnavailableError extends DownloadFailedError {
+ DownloadUnavailableError() : super('Unavailable');
+}
+
+class DownloadDecryptionFailedError extends DownloadFailedError {
+ DownloadDecryptionFailedError() : super('Failed to decrypt downloaded file');
+}
+
+Future<T?> handleDownloadDecryptionFailureForCaller<T>(
+ Future<T?> download, {
+ required bool rethrowDecryptionFailure,
+}) async {
+ try {
+ return await download;
+ } on DownloadDecryptionFailedError {
+ if (rethrowDecryptionFailure) {
+ rethrow;
+ }
+ return null;
+ }
+}
diff --git a/mobile/apps/photos/lib/module/download/file.dart b/mobile/apps/photos/lib/module/download/file.dart
index 1bc73c01db..c21466235e 100644
--- a/mobile/apps/photos/lib/module/download/file.dart
+++ b/mobile/apps/photos/lib/module/download/file.dart
@@ -160,6 +160,7 @@ Future<File?> getFileFromServer(
ProgressCallback? progressCallback,
bool liveVideo = false, // only needed in case of live photos
bool forGalleryDownload = false,
+ bool throwOnDecryptionFailure = false,
}) async {
final cacheManager = (file.fileType == FileType.video || liveVideo)
? VideoCacheManager.instance
@@ -174,33 +175,36 @@ Future<File?> getFileFromServer(
_progressCallbacks[downloadID] = progressCallback;
}
- return _runOncePerKey(
- _fileDownloadsInProgress,
- downloadID,
- () {
- Future<File?> downloadFuture;
- if (file.fileType == FileType.livePhoto) {
- downloadFuture = _getLivePhotoFromServer(
- file,
- progressCallback: (count, total) {
- _progressCallbacks[downloadID]?.call(count, total);
- },
- needLiveVideo: liveVideo,
- forGalleryDownload: forGalleryDownload,
- );
- } else {
- downloadFuture = _downloadAndCache(
- file,
- cacheManager,
- progressCallback: (count, total) {
- _progressCallbacks[downloadID]?.call(count, total);
- },
- forGalleryDownload: forGalleryDownload,
- );
- }
- return downloadFuture;
- },
- onComplete: () => _progressCallbacks.remove(downloadID),
+ return handleDownloadDecryptionFailureForCaller(
+ _runOncePerKey(
+ _fileDownloadsInProgress,
+ downloadID,
+ () {
+ Future<File?> downloadFuture;
+ if (file.fileType == FileType.livePhoto) {
+ downloadFuture = _getLivePhotoFromServer(
+ file,
+ progressCallback: (count, total) {
+ _progressCallbacks[downloadID]?.call(count, total);
+ },
+ needLiveVideo: liveVideo,
+ forGalleryDownload: forGalleryDownload,
+ );
+ } else {
+ downloadFuture = _downloadAndCache(
+ file,
+ cacheManager,
+ progressCallback: (count, total) {
+ _progressCallbacks[downloadID]?.call(count, total);
+ },
+ forGalleryDownload: forGalleryDownload,
+ );
+ }
+ return downloadFuture;
+ },
+ onComplete: () => _progressCallbacks.remove(downloadID),
+ ),
+ rethrowDecryptionFailure: forGalleryDownload || throwOnDecryptionFailure,
);
}
@@ -238,7 +242,7 @@ Future<File?> _getLivePhotoFromServer(
return needLiveVideo ? livePhoto.video : livePhoto.image;
} catch (e, s) {
_logger.warning("live photo get failed", e, s);
- if (forGalleryDownload) {
+ if (forGalleryDownload || e is DownloadDecryptionFailedError) {
rethrow;
}
return null;
@@ -256,6 +260,9 @@ Future<File?> _downloadAndCache(
progressCallback: progressCallback,
forceResumableDownload: forGalleryDownload,
throwOnFailure: forGalleryDownload,
+ // The shared download future must retain the specific failure type.
+ // getFileFromServer decides per caller whether to surface or suppress it.
+ throwOnDecryptionFailure: true,
)
.then((decryptedFile) async {
if (decryptedFile == null) {
diff --git a/mobile/apps/photos/lib/module/live_photo/download.dart b/mobile/apps/photos/lib/module/live_photo/download.dart
index d0af61a469..8a5f0a243f 100644
--- a/mobile/apps/photos/lib/module/live_photo/download.dart
+++ b/mobile/apps/photos/lib/module/live_photo/download.dart
@@ -28,6 +28,9 @@ Future<LivePhotoFiles?> downloadLivePhotoFiles(
progressCallback: progressCallback,
forceResumableDownload: forGalleryDownload,
throwOnFailure: forGalleryDownload,
+ // Keep decryption failures typed for getFileFromServer's caller-specific
+ // error handling, even when this download is shared with a prefetch.
+ throwOnDecryptionFailure: true,
);
if (decryptedFile == null) {
return null;
diff --git a/mobile/apps/photos/lib/ui/viewer/file/video_widget_media_kit.dart b/mobile/apps/photos/lib/ui/viewer/file/video_widget_media_kit.dart
index d4751cddd4..dfbcd41066 100644
--- a/mobile/apps/photos/lib/ui/viewer/file/video_widget_media_kit.dart
+++ b/mobile/apps/photos/lib/ui/viewer/file/video_widget_media_kit.dart
@@ -16,6 +16,7 @@ import "package:photos/events/stream_switched_event.dart";
import "package:photos/events/video_mute_changed_event.dart";
import "package:photos/models/file/extensions/file_props.dart";
import "package:photos/models/file/file.dart";
+import 'package:photos/module/download/download_error.dart';
import "package:photos/module/download/file.dart";
import "package:photos/module/download/task.dart";
import "package:photos/service_locator.dart";
@@ -302,6 +303,7 @@ class _VideoWidgetMediaKitState extends State<VideoWidgetMediaKit>
void _loadNetworkVideo() {
getFileFromServer(
widget.file,
+ throwOnDecryptionFailure: true,
progressCallback: (count, total) {
if (!mounted) {
return;
@@ -321,11 +323,15 @@ class _VideoWidgetMediaKitState extends State<VideoWidgetMediaKit>
})
.onError((error, stackTrace) {
if (!mounted) return;
- showErrorDialog(
- context,
- context.strings.error,
- context.strings.failedToDownloadVideo,
- );
+ if (error is DownloadDecryptionFailedError) {
+ showDownloadDecryptionFailedDialog(context: context);
+ } else {
+ showErrorDialog(
+ context,
+ context.strings.error,
+ context.strings.failedToDownloadVideo,
+ );
+ }
});
}
diff --git a/mobile/apps/photos/lib/ui/viewer/file/video_widget_native.dart b/mobile/apps/photos/lib/ui/viewer/file/video_widget_native.dart
index ae683b4418..30c3a3b481 100644
--- a/mobile/apps/photos/lib/ui/viewer/file/video_widget_native.dart
+++ b/mobile/apps/photos/lib/ui/viewer/file/video_widget_native.dart
@@ -19,6 +19,7 @@ import "package:photos/events/video_mute_changed_event.dart";
import "package:photos/models/file/extensions/file_props.dart";
import "package:photos/models/file/file.dart";
import "package:photos/models/preview/playlist_data.dart";
+import 'package:photos/module/download/download_error.dart';
import "package:photos/module/download/file.dart";
import "package:photos/module/download/task.dart";
import "package:photos/module/metadata/video.dart";
@@ -697,6 +698,7 @@ class _VideoWidgetNativeState extends State<VideoWidgetNative>
void _loadNetworkVideo(bool update) {
getFileFromServer(
widget.file,
+ throwOnDecryptionFailure: true,
progressCallback: (count, total) {
if (!mounted) {
return;
@@ -716,11 +718,15 @@ class _VideoWidgetNativeState extends State<VideoWidgetNative>
})
.onError((error, stackTrace) {
if (!mounted) return;
- showErrorDialog(
- context,
- context.strings.error,
- context.strings.failedToDownloadVideo,
- );
+ if (error is DownloadDecryptionFailedError) {
+ showDownloadDecryptionFailedDialog(context: context);
+ } else {
+ showErrorDialog(
+ context,
+ context.strings.error,
+ context.strings.failedToDownloadVideo,
+ );
+ }
});
}
diff --git a/mobile/apps/photos/lib/ui/viewer/file/zoomable_image.dart b/mobile/apps/photos/lib/ui/viewer/file/zoomable_image.dart
index 984272afe7..4987f297a9 100644
--- a/mobile/apps/photos/lib/ui/viewer/file/zoomable_image.dart
+++ b/mobile/apps/photos/lib/ui/viewer/file/zoomable_image.dart
@@ -17,6 +17,7 @@ import "package:photos/events/reset_zoom_of_photo_view_event.dart";
import "package:photos/events/retry_failed_image_load_event.dart";
import "package:photos/models/file/extensions/file_props.dart";
import 'package:photos/models/file/file.dart';
+import 'package:photos/module/download/download_error.dart';
import 'package:photos/module/download/file.dart';
import 'package:photos/module/download/thumbnail.dart';
import "package:photos/module/metadata/exif.dart";
@@ -26,6 +27,7 @@ import "package:photos/states/detail_page_state.dart";
import "package:photos/ui/actions/file/file_actions.dart";
import "package:photos/ui/viewer/file/image_zoom/image_zoom_viewer.dart";
import 'package:photos/ui/viewer/file/thumbnail_widget.dart';
+import 'package:photos/utils/dialog_util.dart';
import 'package:photos/utils/image_util.dart';
import "package:photos/utils/ram_check_util.dart";
@@ -68,6 +70,7 @@ class _ZoomableImageState extends State<ZoomableImage> {
bool _loadedLargeThumbnail = false;
bool _loadingFinalImage = false;
bool _loadedFinalImage = false;
+ bool _finalImageDecryptionFailed = false;
// Downloads cannot be cancelled. Defer a retry until the current attempt
// fails.
bool _pendingFinalImageRetry = false;
@@ -125,6 +128,7 @@ class _ZoomableImageState extends State<ZoomableImage> {
.on<RetryFailedImageLoadEvent>()
.listen((_) {
if (!mounted || _loadedFinalImage) return;
+ _finalImageDecryptionFailed = false;
if (!_loadedSmallThumbnail && _photo.isRemoteOnlyFile) {
// Thumbnail requests are deduplicated. Evict the failed request
// before retrying.
@@ -295,9 +299,11 @@ class _ZoomableImageState extends State<ZoomableImage> {
});
}
}
- if (!_loadedFinalImage && !_loadingFinalImage) {
+ if (!_loadedFinalImage &&
+ !_loadingFinalImage &&
+ !_finalImageDecryptionFailed) {
_loadingFinalImage = true;
- getFileFromServer(_photo)
+ getFileFromServer(_photo, throwOnDecryptionFailure: true)
.then((file) {
if (file != null) {
_onFileLoaded(file);
@@ -312,7 +318,11 @@ class _ZoomableImageState extends State<ZoomableImage> {
e,
s,
);
- _onFinalImageFetchFailed();
+ if (e is DownloadDecryptionFailedError) {
+ _onFinalImageDecryptionFailed();
+ } else {
+ _onFinalImageFetchFailed();
+ }
});
}
}
@@ -489,6 +499,13 @@ class _ZoomableImageState extends State<ZoomableImage> {
}
}
+ void _onFinalImageDecryptionFailed() {
+ _loadingFinalImage = false;
+ _finalImageDecryptionFailed = true;
+ if (!mounted) return;
+ unawaited(showDownloadDecryptionFailedDialog(context: context));
+ }
+
Future<void> _loadHeicWithRust(File file) async {
final imageProvider = await _tryDecodeHeicWithRust(file);
if (imageProvider != null) {
diff --git a/mobile/apps/photos/lib/utils/dialog_util.dart b/mobile/apps/photos/lib/utils/dialog_util.dart
index 8f43cbd8cc..3ea8869d14 100644
--- a/mobile/apps/photos/lib/utils/dialog_util.dart
+++ b/mobile/apps/photos/lib/utils/dialog_util.dart
@@ -6,6 +6,7 @@ import "package:flutter/foundation.dart";
import 'package:flutter/material.dart';
import "package:flutter/services.dart";
import 'package:flutter_inappwebview/flutter_inappwebview.dart';
+import 'package:photos/core/constants.dart';
import 'package:photos/models/button_result.dart';
import 'package:photos/models/typedefs.dart';
import "package:photos/module/download/manager.dart";
@@ -208,6 +209,37 @@ Future<ButtonResult?> showGenericErrorDialog({
return result;
}
+Future<ButtonResult?> showDownloadDecryptionFailedDialog({
+ required BuildContext context,
+}) async {
+ final title = pendingTranslation('Download failed');
+ return showDialogWidget(
+ context: context,
+ title: title,
+ icon: Icons.error_outline_outlined,
+ body: pendingTranslation(
+ 'This item could not be downloaded. Please reach out to us so we can help.',
+ ),
+ buttons: [
+ ButtonWidget(
+ buttonType: ButtonType.primary,
+ labelText: pendingTranslation('Contact us'),
+ buttonAction: ButtonAction.first,
+ isInAlert: true,
+ onTap: () async {
+ await sendLogs(
+ context,
+ title,
+ supportEmail,
+ subject: title,
+ postShare: () {},
+ );
+ },
+ ),
+ ],
+ );
+}
+
Future<void> showGenericErrorBottomSheet({
required BuildContext context,
required Object? error,
diff --git a/mobile/apps/photos/test/module/download/download_error_test.dart b/mobile/apps/photos/test/module/download/download_error_test.dart
new file mode 100644
index 0000000000..35be3cc9d1
--- /dev/null
+++ b/mobile/apps/photos/test/module/download/download_error_test.dart
@@ -0,0 +1,40 @@
+import 'package:flutter_test/flutter_test.dart';
+import 'package:photos/module/download/download_error.dart';
+
+void main() {
+ group('download decryption failures', () {
+ test('are distinguishable from other download failures', () {
+ final error = DownloadDecryptionFailedError();
+
+ expect(error, isA<DownloadFailedError>());
+ expect(error, isNot(isA<DownloadNoConnectionError>()));
+ expect(error.toString(), 'Failed to decrypt downloaded file');
+ });
+
+ test('can be suppressed for an existing caller', () async {
+ final result = await handleDownloadDecryptionFailureForCaller<int>(
+ Future<int?>.error(DownloadDecryptionFailedError()),
+ rethrowDecryptionFailure: false,
+ );
+
+ expect(result, isNull);
+ });
+
+ test('can be surfaced to a viewer sharing the same download', () async {
+ final sharedDownload = Future<int?>.error(
+ DownloadDecryptionFailedError(),
+ );
+ final existingCaller = handleDownloadDecryptionFailureForCaller<int>(
+ sharedDownload,
+ rethrowDecryptionFailure: false,
+ );
+ final viewer = handleDownloadDecryptionFailureForCaller<int>(
+ sharedDownload,
+ rethrowDecryptionFailure: true,
+ );
+
+ expect(await existingCaller, isNull);
+ await expectLater(viewer, throwsA(isA<DownloadDecryptionFailedError>()));
+ });
+ });
+}
diff --git a/mobile/apps/photos/test/ui/components/dialog_widget_test.dart b/mobile/apps/photos/test/ui/components/dialog_widget_test.dart
index 9a4f99abf7..306068c0b3 100644
--- a/mobile/apps/photos/test/ui/components/dialog_widget_test.dart
+++ b/mobile/apps/photos/test/ui/components/dialog_widget_test.dart
@@ -1,8 +1,8 @@
import "package:ente_components/ente_components.dart";
+import "package:ente_strings/ente_strings.dart";
import "package:flutter/material.dart";
import "package:flutter_test/flutter_test.dart";
import "package:photos/ente_theme_data.dart";
-import "package:ente_strings/ente_strings.dart";
import "package:photos/models/button_result.dart";
import "package:photos/ui/components/buttons/button_widget.dart";
import "package:photos/ui/components/dialog_widget.dart";
@@ -39,6 +39,34 @@ void main() {
await tester.pumpAndSettle();
expect(find.byType(BottomSheetComponent), findsNothing);
});
+
+ testWidgets("shows the download decryption failure support action", (
+ tester,
+ ) async {
+ await _pumpLauncher(
+ tester,
+ (context) => showDownloadDecryptionFailedDialog(context: context),
+ );
+
+ await _openLauncher(tester);
+
+ expect(find.text("Download failed"), findsOneWidget);
+ expect(
+ find.text(
+ "This item could not be downloaded. Please reach out to us so we can help.",
+ ),
+ findsOneWidget,
+ );
+ expect(find.text("Contact us"), findsOneWidget);
+ expect(find.byType(BottomSheetComponent), findsOneWidget);
+
+ await tester.tap(find.text("Contact us"));
+ await tester.pumpAndSettle();
+
+ expect(find.text("Report a bug"), findsWidgets);
+ expect(find.text("View logs"), findsOneWidget);
+ expect(find.text("Export logs"), findsOneWidget);
+ });
});
group("showTextInputDialog", () {