fix(mobile): auto trash using MANAGE_MEDIA (immich-app#17828)

fix: auto trash using MANAGE_MEDIA

Co-authored-by: shenlong-tanwen <[email protected]>

Author: shenlong-tanwen

mobile/android/app/src/main/kotlin/app/alextran/immich/BackgroundServicePlugin.kt

@@ -1,25 +1,42 @@
 package app.alextran.immich
 
+import android.app.Activity
+import android.content.ContentResolver
+import android.content.ContentUris
 import android.content.Context
+import android.content.Intent
+import android.net.Uri
+import android.os.Build
+import android.os.Bundle
+import android.provider.MediaStore
+import android.provider.Settings
 import android.util.Log
+import androidx.annotation.RequiresApi
 import io.flutter.embedding.engine.plugins.FlutterPlugin
+import io.flutter.embedding.engine.plugins.activity.ActivityAware
+import io.flutter.embedding.engine.plugins.activity.ActivityPluginBinding
 import io.flutter.plugin.common.BinaryMessenger
 import io.flutter.plugin.common.MethodCall
 import io.flutter.plugin.common.MethodChannel
+import io.flutter.plugin.common.MethodChannel.Result
+import io.flutter.plugin.common.PluginRegistry
 import java.security.MessageDigest
 import java.io.FileInputStream
 import kotlinx.coroutines.*
+import androidx.core.net.toUri
 
 /**
- * Android plugin for Dart `BackgroundService`
- *
- * Receives messages/method calls from the foreground Dart side to manage
- * the background service, e.g. start (enqueue), stop (cancel)
+ * Android plugin for Dart `BackgroundService` and file trash operations
  */
-class BackgroundServicePlugin : FlutterPlugin, MethodChannel.MethodCallHandler {
+class BackgroundServicePlugin : FlutterPlugin, MethodChannel.MethodCallHandler, ActivityAware, PluginRegistry.ActivityResultListener {
 
   private var methodChannel: MethodChannel? = null
+  private var fileTrashChannel: MethodChannel? = null
   private var context: Context? = null
+  private var pendingResult: Result? = null
+  private val permissionRequestCode = 1001
+  private val trashRequestCode = 1002
+  private var activityBinding: ActivityPluginBinding? = null
 
   override fun onAttachedToEngine(binding: FlutterPlugin.FlutterPluginBinding) {
     onAttachedToEngine(binding.applicationContext, binding.binaryMessenger)
@@ -29,6 +46,10 @@ class BackgroundServicePlugin : FlutterPlugin, MethodChannel.MethodCallHandler {
     context = ctx
     methodChannel = MethodChannel(messenger, "immich/foregroundChannel")
     methodChannel?.setMethodCallHandler(this)
+
+    // Add file trash channel
+    fileTrashChannel = MethodChannel(messenger, "file_trash")
+    fileTrashChannel?.setMethodCallHandler(this)
   }
 
   override fun onDetachedFromEngine(binding: FlutterPlugin.FlutterPluginBinding) {
@@ -38,11 +59,14 @@ class BackgroundServicePlugin : FlutterPlugin, MethodChannel.MethodCallHandler {
   private fun onDetachedFromEngine() {
     methodChannel?.setMethodCallHandler(null)
     methodChannel = null
+    fileTrashChannel?.setMethodCallHandler(null)
+    fileTrashChannel = null
   }
 
-  override fun onMethodCall(call: MethodCall, result: MethodChannel.Result) {
+  override fun onMethodCall(call: MethodCall, result: Result) {
     val ctx = context!!
     when (call.method) {
+      // Existing BackgroundService methods
       "enable" -> {
         val args = call.arguments<ArrayList<*>>()!!
         ctx.getSharedPreferences(BackupWorker.SHARED_PREF_NAME, Context.MODE_PRIVATE)
@@ -114,10 +138,184 @@ class BackgroundServicePlugin : FlutterPlugin, MethodChannel.MethodCallHandler {
         }
       }
 
+      // File Trash methods moved from MainActivity
+      "moveToTrash" -> {
+        val mediaUrls = call.argument<List<String>>("mediaUrls")
+        if (mediaUrls != null) {
+          if ((Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) && hasManageMediaPermission()) {
+              moveToTrash(mediaUrls, result)
+          } else {
+            result.error("PERMISSION_DENIED", "Media permission required", null)
+          }
+        } else {
+          result.error("INVALID_NAME", "The mediaUrls is not specified.", null)
+        }
+      }
+
+      "restoreFromTrash" -> {
+        val fileName = call.argument<String>("fileName")
+        val type = call.argument<Int>("type")
+        if (fileName != null && type != null) {
+          if ((Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) && hasManageMediaPermission()) {
+            restoreFromTrash(fileName, type, result)
+          } else {
+            result.error("PERMISSION_DENIED", "Media permission required", null)
+          }
+        } else {
+          result.error("INVALID_NAME", "The file name is not specified.", null)
+        }
+      }
+
+      "requestManageMediaPermission" -> {
+        if (!hasManageMediaPermission()) {
+          requestManageMediaPermission(result)
+        } else {
+          Log.e("Manage storage permission", "Permission already granted")
+          result.success(true)
+        }
+      }
+
       else -> result.notImplemented()
     }
   }
+
+  private fun hasManageMediaPermission(): Boolean {
+    return if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S) {
+      MediaStore.canManageMedia(context!!);
+    } else  {
+      false
+    }
+  }
+
+  private fun requestManageMediaPermission(result: Result) {
+    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S) {
+      pendingResult = result // Store the result callback
+      val activity = activityBinding?.activity ?: return
+
+      val intent = Intent(Settings.ACTION_REQUEST_MANAGE_MEDIA)
+      intent.data = "package:${activity.packageName}".toUri()
+      activity.startActivityForResult(intent, permissionRequestCode)
+    } else {
+      result.success(false)
+    }
+  }
+
+  @RequiresApi(Build.VERSION_CODES.R)
+  private fun moveToTrash(mediaUrls: List<String>, result: Result) {
+    val urisToTrash = mediaUrls.map { it.toUri() }
+    if (urisToTrash.isEmpty()) {
+      result.error("INVALID_ARGS", "No valid URIs provided", null)
+      return
+    }
+
+    toggleTrash(urisToTrash, true, result);
+  }
+
+  @RequiresApi(Build.VERSION_CODES.R)
+  private fun restoreFromTrash(name: String, type: Int, result: Result) {
+    val uri = getTrashedFileUri(name, type)
+    if (uri == null) {
+      Log.e("TrashError", "Asset Uri cannot be found obtained")
+      result.error("TrashError", "Asset Uri cannot be found obtained", null)
+      return
+    }
+    Log.e("FILE_URI", uri.toString())
+    uri.let { toggleTrash(listOf(it), false, result) }
+  }
+
+  @RequiresApi(Build.VERSION_CODES.R)
+  private fun toggleTrash(contentUris: List<Uri>, isTrashed: Boolean, result: Result) {
+      val activity = activityBinding?.activity
+      val contentResolver = context?.contentResolver
+      if (activity == null || contentResolver == null) {
+        result.error("TrashError", "Activity or ContentResolver not available", null)
+        return
+      }
+
+      try {
+        val pendingIntent = MediaStore.createTrashRequest(contentResolver, contentUris, isTrashed)
+        pendingResult = result // Store for onActivityResult
+        activity.startIntentSenderForResult(
+          pendingIntent.intentSender,
+          trashRequestCode,
+          null, 0, 0, 0
+        )
+      } catch (e: Exception) {
+        Log.e("TrashError", "Error creating or starting trash request", e)
+        result.error("TrashError", "Error creating or starting trash request", null)
+    }
+  }
+
+  @RequiresApi(Build.VERSION_CODES.R)
+  private fun getTrashedFileUri(fileName: String, type: Int): Uri? {
+    val contentResolver = context?.contentResolver ?: return null
+    val queryUri = MediaStore.Files.getContentUri(MediaStore.VOLUME_EXTERNAL)
+    val projection = arrayOf(MediaStore.Files.FileColumns._ID)
+
+    val queryArgs = Bundle().apply {
+      putString(
+        ContentResolver.QUERY_ARG_SQL_SELECTION,
+        "${MediaStore.Files.FileColumns.DISPLAY_NAME} = ?"
+      )
+      putStringArray(ContentResolver.QUERY_ARG_SQL_SELECTION_ARGS, arrayOf(fileName))
+      putInt(MediaStore.QUERY_ARG_MATCH_TRASHED, MediaStore.MATCH_ONLY)
+    }
+
+    contentResolver.query(queryUri, projection, queryArgs, null)?.use { cursor ->
+      if (cursor.moveToFirst()) {
+        val id = cursor.getLong(cursor.getColumnIndexOrThrow(MediaStore.Files.FileColumns._ID))
+        // same order as AssetType from dart
+        val contentUri = when (type) {
+          1 -> MediaStore.Images.Media.EXTERNAL_CONTENT_URI
+          2 -> MediaStore.Video.Media.EXTERNAL_CONTENT_URI
+          3 -> MediaStore.Audio.Media.EXTERNAL_CONTENT_URI
+          else -> queryUri
+        }
+        return ContentUris.withAppendedId(contentUri, id)
+      }
+    }
+    return null
+  }
+
+  // ActivityAware implementation
+  override fun onAttachedToActivity(binding: ActivityPluginBinding) {
+    activityBinding = binding
+    binding.addActivityResultListener(this)
+  }
+
+  override fun onDetachedFromActivityForConfigChanges() {
+    activityBinding?.removeActivityResultListener(this)
+    activityBinding = null
+  }
+
+  override fun onReattachedToActivityForConfigChanges(binding: ActivityPluginBinding) {
+    activityBinding = binding
+    binding.addActivityResultListener(this)
+  }
+
+  override fun onDetachedFromActivity() {
+    activityBinding?.removeActivityResultListener(this)
+    activityBinding = null
+  }
+
+  // ActivityResultListener implementation
+  override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?): Boolean {
+    if (requestCode == permissionRequestCode) {
+      val granted = hasManageMediaPermission()
+      pendingResult?.success(granted)
+      pendingResult = null
+      return true
+    }
+
+    if (requestCode == trashRequestCode) {
+      val approved = resultCode == Activity.RESULT_OK
+      pendingResult?.success(approved)
+      pendingResult = null
+      return true
+    }
+    return false
+  }
 }
 
 private const val TAG = "BackgroundServicePlugin"
-private const val BUFFER_SIZE = 2 * 1024 * 1024;
+private const val BUFFER_SIZE = 2 * 1024 * 1024

mobile/android/app/src/main/kotlin/app/alextran/immich/MainActivity.kt

@@ -2,14 +2,12 @@ package app.alextran.immich
 
 import io.flutter.embedding.android.FlutterActivity
 import io.flutter.embedding.engine.FlutterEngine
-import android.os.Bundle
-import android.content.Intent
+import androidx.annotation.NonNull
 
 class MainActivity : FlutterActivity() {
-
-    override fun configureFlutterEngine(flutterEngine: FlutterEngine) {
+    override fun configureFlutterEngine(@NonNull flutterEngine: FlutterEngine) {
         super.configureFlutterEngine(flutterEngine)
         flutterEngine.plugins.add(BackgroundServicePlugin())
+        // No need to set up method channel here as it's now handled in the plugin
     }
-
 }

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),