fix(mobile): auto trash using MANAGE_MEDIA (#17828)

fix: auto trash using MANAGE_MEDIA

Co-authored-by: shenlong-tanwen <139912620+shalong-tanwen@users.noreply.github.com>

mobile/lib/domain/models/store.model.dart

@@ -65,6 +65,7 @@ enum StoreKey<T> {
 
   // Video settings
   loadOriginalVideo<bool>._(136),
+  manageLocalMediaAndroid<bool>._(137),
 
   // Experimental stuff
   photoManagerCustomFilter<bool>._(1000);

mobile/lib/interfaces/local_files_manager.interface.dart

@@ -0,0 +1,5 @@
+abstract interface class ILocalFilesManager {
+  Future<bool> moveToTrash(List<String> mediaUrls);
+  Future<bool> restoreFromTrash(String fileName, int type);
+  Future<bool> requestManageMediaPermission();
+}

mobile/lib/providers/websocket.provider.dart

@@ -23,6 +23,7 @@ enum PendingAction {
   assetDelete,
   assetUploaded,
   assetHidden,
+  assetTrash,
 }
 
 class PendingChange {
@@ -160,7 +161,7 @@ class WebsocketNotifier extends StateNotifier<WebsocketState> {
         socket.on('on_upload_success', _handleOnUploadSuccess);
         socket.on('on_config_update', _handleOnConfigUpdate);
         socket.on('on_asset_delete', _handleOnAssetDelete);
-        socket.on('on_asset_trash', _handleServerUpdates);
+        socket.on('on_asset_trash', _handleOnAssetTrash);
         socket.on('on_asset_restore', _handleServerUpdates);
         socket.on('on_asset_update', _handleServerUpdates);
         socket.on('on_asset_stack_update', _handleServerUpdates);
@@ -207,6 +208,26 @@ class WebsocketNotifier extends StateNotifier<WebsocketState> {
     _debounce.run(handlePendingChanges);
   }
 
+  Future<void> _handlePendingTrashes() async {
+    final trashChanges = state.pendingChanges
+        .where((c) => c.action == PendingAction.assetTrash)
+        .toList();
+    if (trashChanges.isNotEmpty) {
+      List<String> remoteIds = trashChanges
+          .expand((a) => (a.value as List).map((e) => e.toString()))
+          .toList();
+
+      await _ref.read(syncServiceProvider).handleRemoteAssetRemoval(remoteIds);
+      await _ref.read(assetProvider.notifier).getAllAsset();
+
+      state = state.copyWith(
+        pendingChanges: state.pendingChanges
+            .whereNot((c) => trashChanges.contains(c))
+            .toList(),
+      );
+    }
+  }
+
   Future<void> _handlePendingDeletes() async {
     final deleteChanges = state.pendingChanges
         .where((c) => c.action == PendingAction.assetDelete)
@@ -267,6 +288,7 @@ class WebsocketNotifier extends StateNotifier<WebsocketState> {
     await _handlePendingUploaded();
     await _handlePendingDeletes();
     await _handlingPendingHidden();
+    await _handlePendingTrashes();
   }
 
   void _handleOnConfigUpdate(dynamic _) {
@@ -285,6 +307,10 @@ class WebsocketNotifier extends StateNotifier<WebsocketState> {
   void _handleOnAssetDelete(dynamic data) =>
       addPendingChange(PendingAction.assetDelete, data);
 
+  void _handleOnAssetTrash(dynamic data) {
+    addPendingChange(PendingAction.assetTrash, data);
+  }
+
   void _handleOnAssetHidden(dynamic data) =>
       addPendingChange(PendingAction.assetHidden, data);
 

mobile/lib/repositories/local_files_manager.repository.dart

@@ -0,0 +1,25 @@
+import 'package:hooks_riverpod/hooks_riverpod.dart';
+import 'package:immich_mobile/interfaces/local_files_manager.interface.dart';
+import 'package:immich_mobile/utils/local_files_manager.dart';
+
+final localFilesManagerRepositoryProvider =
+    Provider((ref) => const LocalFilesManagerRepository());
+
+class LocalFilesManagerRepository implements ILocalFilesManager {
+  const LocalFilesManagerRepository();
+
+  @override
+  Future<bool> moveToTrash(List<String> mediaUrls) async {
+    return await LocalFilesManager.moveToTrash(mediaUrls);
+  }
+
+  @override
+  Future<bool> restoreFromTrash(String fileName, int type) async {
+    return await LocalFilesManager.restoreFromTrash(fileName, type);
+  }
+
+  @override
+  Future<bool> requestManageMediaPermission() async {
+    return await LocalFilesManager.requestManageMediaPermission();
+  }
+}

mobile/lib/services/app_settings.service.dart

@@ -61,6 +61,7 @@ enum AppSettingsEnum<T> {
     0,
   ),
   advancedTroubleshooting<bool>(StoreKey.advancedTroubleshooting, null, false),
+  manageLocalMediaAndroid<bool>(StoreKey.manageLocalMediaAndroid, null, false),
   logLevel<int>(StoreKey.logLevel, null, 5), // Level.INFO = 5
   preferRemoteImage<bool>(StoreKey.preferRemoteImage, null, false),
   loopVideo<bool>(StoreKey.loopVideo, "loopVideo", true),

mobile/lib/services/sync.service.dart

@@ -1,4 +1,5 @@
 import 'dart:async';
+import 'dart:io';
 
 import 'package:collection/collection.dart';
 import 'package:hooks_riverpod/hooks_riverpod.dart';
@@ -16,8 +17,10 @@ import 'package:immich_mobile/interfaces/album_api.interface.dart';
 import 'package:immich_mobile/interfaces/album_media.interface.dart';
 import 'package:immich_mobile/interfaces/asset.interface.dart';
 import 'package:immich_mobile/interfaces/etag.interface.dart';
+import 'package:immich_mobile/interfaces/local_files_manager.interface.dart';
 import 'package:immich_mobile/interfaces/partner.interface.dart';
 import 'package:immich_mobile/interfaces/partner_api.interface.dart';
+import 'package:immich_mobile/providers/app_settings.provider.dart';
 import 'package:immich_mobile/providers/infrastructure/exif.provider.dart';
 import 'package:immich_mobile/providers/infrastructure/user.provider.dart';
 import 'package:immich_mobile/repositories/album.repository.dart';
@@ -25,8 +28,10 @@ import 'package:immich_mobile/repositories/album_api.repository.dart';
 import 'package:immich_mobile/repositories/album_media.repository.dart';
 import 'package:immich_mobile/repositories/asset.repository.dart';
 import 'package:immich_mobile/repositories/etag.repository.dart';
+import 'package:immich_mobile/repositories/local_files_manager.repository.dart';
 import 'package:immich_mobile/repositories/partner.repository.dart';
 import 'package:immich_mobile/repositories/partner_api.repository.dart';
+import 'package:immich_mobile/services/app_settings.service.dart';
 import 'package:immich_mobile/services/entity.service.dart';
 import 'package:immich_mobile/services/hash.service.dart';
 import 'package:immich_mobile/utils/async_mutex.dart';
@@ -48,6 +53,8 @@ final syncServiceProvider = Provider(
     ref.watch(userRepositoryProvider),
     ref.watch(userServiceProvider),
     ref.watch(etagRepositoryProvider),
+    ref.watch(appSettingsServiceProvider),
+    ref.watch(localFilesManagerRepositoryProvider),
     ref.watch(partnerApiRepositoryProvider),
     ref.watch(userApiRepositoryProvider),
   ),
@@ -69,6 +76,8 @@ class SyncService {
   final IUserApiRepository _userApiRepository;
   final AsyncMutex _lock = AsyncMutex();
   final Logger _log = Logger('SyncService');
+  final AppSettingsService _appSettingsService;
+  final ILocalFilesManager _localFilesManager;
 
   SyncService(
     this._hashService,
@@ -82,6 +91,8 @@ class SyncService {
     this._userRepository,
     this._userService,
     this._eTagRepository,
+    this._appSettingsService,
+    this._localFilesManager,
     this._partnerApiRepository,
     this._userApiRepository,
   );
@@ -238,8 +249,22 @@ class SyncService {
     return null;
   }
 
+  Future<void> _moveToTrashMatchedAssets(Iterable<String> idsToDelete) async {
+    final List<Asset> localAssets = await _assetRepository.getAllLocal();
+    final List<Asset> matchedAssets = localAssets
+        .where((asset) => idsToDelete.contains(asset.remoteId))
+        .toList();
+
+    final mediaUrls = await Future.wait(
+      matchedAssets
+          .map((asset) => asset.local?.getMediaUrl() ?? Future.value(null)),
+    );
+
+    await _localFilesManager.moveToTrash(mediaUrls.nonNulls.toList());
+  }
+
   /// Deletes remote-only assets, updates merged assets to be local-only
-  Future<void> handleRemoteAssetRemoval(List<String> idsToDelete) {
+  Future<void> handleRemoteAssetRemoval(List<String> idsToDelete) async {
     return _assetRepository.transaction(() async {
       await _assetRepository.deleteAllByRemoteId(
         idsToDelete,
@@ -249,6 +274,12 @@ class SyncService {
         idsToDelete,
         state: AssetState.merged,
       );
+      if (Platform.isAndroid &&
+          _appSettingsService.getSetting<bool>(
+            AppSettingsEnum.manageLocalMediaAndroid,
+          )) {
+        await _moveToTrashMatchedAssets(idsToDelete);
+      }
       if (merged.isEmpty) return;
       for (final Asset asset in merged) {
         asset.remoteId = null;
@@ -790,10 +821,43 @@ class SyncService {
     return (existing, toUpsert);
   }
 
+  Future<void> _toggleTrashStatusForAssets(List<Asset> assetsList) async {
+    final trashMediaUrls = <String>[];
+
+    for (final asset in assetsList) {
+      if (asset.isTrashed) {
+        final mediaUrl = await asset.local?.getMediaUrl();
+        if (mediaUrl == null) {
+          _log.warning(
+            "Failed to get media URL for asset ${asset.name} while moving to trash",
+          );
+          continue;
+        }
+        trashMediaUrls.add(mediaUrl);
+      } else {
+        await _localFilesManager.restoreFromTrash(
+          asset.fileName,
+          asset.type.index,
+        );
+      }
+    }
+
+    if (trashMediaUrls.isNotEmpty) {
+      await _localFilesManager.moveToTrash(trashMediaUrls);
+    }
+  }
+
   /// Inserts or updates the assets in the database with their ExifInfo (if any)
   Future<void> upsertAssetsWithExif(List<Asset> assets) async {
     if (assets.isEmpty) return;
 
+    if (Platform.isAndroid &&
+        _appSettingsService.getSetting<bool>(
+          AppSettingsEnum.manageLocalMediaAndroid,
+        )) {
+      _toggleTrashStatusForAssets(assets);
+    }
+
     try {
       await _assetRepository.transaction(() async {
         await _assetRepository.updateAll(assets);

mobile/lib/utils/local_files_manager.dart

@@ -0,0 +1,38 @@
+import 'package:flutter/services.dart';
+import 'package:logging/logging.dart';
+
+abstract final class LocalFilesManager {
+  static final Logger _logger = Logger('LocalFilesManager');
+  static const MethodChannel _channel = MethodChannel('file_trash');
+
+  static Future<bool> moveToTrash(List<String> mediaUrls) async {
+    try {
+      return await _channel
+          .invokeMethod('moveToTrash', {'mediaUrls': mediaUrls});
+    } catch (e, s) {
+      _logger.warning('Error moving file to trash', e, s);
+      return false;
+    }
+  }
+
+  static Future<bool> restoreFromTrash(String fileName, int type) async {
+    try {
+      return await _channel.invokeMethod(
+        'restoreFromTrash',
+        {'fileName': fileName, 'type': type},
+      );
+    } catch (e, s) {
+      _logger.warning('Error restore file from trash', e, s);
+      return false;
+    }
+  }
+
+  static Future<bool> requestManageMediaPermission() async {
+    try {
+      return await _channel.invokeMethod('requestManageMediaPermission');
+    } catch (e, s) {
+      _logger.warning('Error requesting manage media permission', e, s);
+      return false;
+    }
+  }
+}

mobile/lib/widgets/settings/advanced_settings.dart

@@ -1,11 +1,13 @@
 import 'dart:io';
 
+import 'package:device_info_plus/device_info_plus.dart';
 import 'package:easy_localization/easy_localization.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_hooks/flutter_hooks.dart' hide Store;
 import 'package:hooks_riverpod/hooks_riverpod.dart';
 import 'package:immich_mobile/domain/services/log.service.dart';
 import 'package:immich_mobile/providers/user.provider.dart';
+import 'package:immich_mobile/repositories/local_files_manager.repository.dart';
 import 'package:immich_mobile/services/app_settings.service.dart';
 import 'package:immich_mobile/utils/hooks/app_settings_update_hook.dart';
 import 'package:immich_mobile/utils/http_ssl_cert_override.dart';
@@ -25,6 +27,8 @@ class AdvancedSettings extends HookConsumerWidget {
 
     final advancedTroubleshooting =
         useAppSettingsState(AppSettingsEnum.advancedTroubleshooting);
+    final manageLocalMediaAndroid =
+        useAppSettingsState(AppSettingsEnum.manageLocalMediaAndroid);
     final levelId = useAppSettingsState(AppSettingsEnum.logLevel);
     final preferRemote = useAppSettingsState(AppSettingsEnum.preferRemoteImage);
     final allowSelfSignedSSLCert =
@@ -40,6 +44,16 @@ class AdvancedSettings extends HookConsumerWidget {
           LogService.I.setlogLevel(Level.LEVELS[levelId.value].toLogLevel()),
     );
 
+    Future<bool> checkAndroidVersion() async {
+      if (Platform.isAndroid) {
+        DeviceInfoPlugin deviceInfo = DeviceInfoPlugin();
+        AndroidDeviceInfo androidInfo = await deviceInfo.androidInfo;
+        int sdkVersion = androidInfo.version.sdkInt;
+        return sdkVersion >= 31;
+      }
+      return false;
+    }
+
     final advancedSettings = [
       SettingsSwitchListTile(
         enabled: true,
@@ -47,6 +61,29 @@ class AdvancedSettings extends HookConsumerWidget {
         title: "advanced_settings_troubleshooting_title".tr(),
         subtitle: "advanced_settings_troubleshooting_subtitle".tr(),
       ),
+      FutureBuilder<bool>(
+        future: checkAndroidVersion(),
+        builder: (context, snapshot) {
+          if (snapshot.hasData && snapshot.data == true) {
+            return SettingsSwitchListTile(
+              enabled: true,
+              valueNotifier: manageLocalMediaAndroid,
+              title: "advanced_settings_sync_remote_deletions_title".tr(),
+              subtitle: "advanced_settings_sync_remote_deletions_subtitle".tr(),
+              onChanged: (value) async {
+                if (value) {
+                  final result = await ref
+                      .read(localFilesManagerRepositoryProvider)
+                      .requestManageMediaPermission();
+                  manageLocalMediaAndroid.value = result;
+                }
+              },
+            );
+          } else {
+            return const SizedBox.shrink();
+          }
+        },
+      ),
       SettingsSliderListTile(
         text: "advanced_settings_log_level_title".tr(args: [logLevel]),
         valueNotifier: levelId,