(#110) Add persistablePermission and grantWritePermission to openDocumentTree and openDocument

Author: alexcmgit

android/src/main/kotlin/io/alexrintt/sharedstorage/storageaccessframework/DocumentFileApi.kt

@@ -7,6 +7,7 @@ import android.provider.DocumentsContract
 import android.util.Log
 import androidx.annotation.RequiresApi
 import androidx.documentfile.provider.DocumentFile
+import com.anggrayudi.storage.extension.isTreeDocumentFile
 import com.anggrayudi.storage.file.child
 import io.flutter.plugin.common.*
 import io.flutter.plugin.common.EventChannel.StreamHandler
@@ -256,7 +257,6 @@ internal class DocumentFileApi(private val plugin: SharedStoragePlugin) :
 
   @RequiresApi(API_21)
   private fun openDocument(call: MethodCall, result: MethodChannel.Result) {
-
     val initialUri = call.argument<String>("initialUri")
 
     val intent =
@@ -380,7 +380,8 @@ internal class DocumentFileApi(private val plugin: SharedStoragePlugin) :
                   "isReadPermission" to it.isReadPermission,
                   "isWritePermission" to it.isWritePermission,
                   "persistedTime" to it.persistedTime,
-                  "uri" to "${it.uri}"
+                  "uri" to "${it.uri}",
+                  "isTreeDocumentFile" to it.uri.isTreeDocumentFile
               )
             }
             .toList()
@@ -404,16 +405,19 @@ internal class DocumentFileApi(private val plugin: SharedStoragePlugin) :
         val pendingResult = pendingResults[OPEN_DOCUMENT_TREE_CODE] ?: return false
 
         val grantWritePermission = pendingResult.first.argument<Boolean>("grantWritePermission")!!
+        val persistablePermission = pendingResult.first.argument<Boolean>("persistablePermission")!!
 
         try {
           val uri = data?.data
 
           if (uri != null) {
-            plugin.context.contentResolver.takePersistableUriPermission(
+            if (persistablePermission) {
+              plugin.context.contentResolver.takePersistableUriPermission(
                 uri,
                 if (grantWritePermission) Intent.FLAG_GRANT_WRITE_URI_PERMISSION
                 else Intent.FLAG_GRANT_READ_URI_PERMISSION
-            )
+              )
+            }
 
             pendingResult.second.success("$uri")
 
@@ -428,13 +432,26 @@ internal class DocumentFileApi(private val plugin: SharedStoragePlugin) :
       OPEN_DOCUMENT_CODE -> {
         val pendingResult = pendingResults[OPEN_DOCUMENT_CODE] ?: return false
 
+        val grantWritePermission = pendingResult.first.argument<Boolean>("grantWritePermission")!!
+        val persistablePermission = pendingResult.first.argument<Boolean>("persistablePermission")!!
+
         try {
           // if data.clipData not null, uriList from data.clipData, else uriList is data.data
           val uriList = data?.clipData?.let {
             (0 until it.itemCount).map { i -> it.getItemAt(i).uri }
           } ?: data?.data?.let { listOf(it) }
 
           if (uriList != null) {
+            if (persistablePermission) {
+              for (uri in uriList) {
+                plugin.context.contentResolver.takePersistableUriPermission(
+                  uri,
+                  if (grantWritePermission) Intent.FLAG_GRANT_WRITE_URI_PERMISSION
+                  else Intent.FLAG_GRANT_READ_URI_PERMISSION
+                )
+              }
+            }
+
             pendingResult.second.success(uriList.map { "$it" })
 
             return true

lib/src/saf/saf.dart

@@ -20,12 +20,14 @@ import 'common.dart';
 /// {@endtemplate}
 Future<Uri?> openDocumentTree({
   bool grantWritePermission = true,
+  bool persistablePermission = true,
   Uri? initialUri,
 }) async {
   const kOpenDocumentTree = 'openDocumentTree';
 
   final args = <String, dynamic>{
     'grantWritePermission': grantWritePermission,
+    'persistablePermission': persistablePermission,
     if (initialUri != null) 'initialUri': '$initialUri',
   };
 
@@ -38,21 +40,26 @@ Future<Uri?> openDocumentTree({
 /// [Refer to details](https://developer.android.com/reference/android/content/Intent#ACTION_OPEN_DOCUMENT).
 Future<List<Uri>?> openDocument({
   Uri? initialUri,
+  bool grantWritePermission = true,
+  bool persistablePermission = true,
   String mimeType = '*/*',
   bool multiple = false,
 }) async {
   const kOpenDocument = 'openDocument';
 
   final args = <String, dynamic>{
     if (initialUri != null) 'initialUri': '$initialUri',
+    'grantWritePermission': grantWritePermission,
+    'persistablePermission': persistablePermission,
     'mimeType': mimeType,
     'multiple': multiple,
   };
 
   final selectedUriList =
       await kDocumentFileChannel.invokeListMethod(kOpenDocument, args);
 
-  return selectedUriList?.apply((e) => e.map((e) => Uri.parse(e as String)).toList());
+  return selectedUriList
+      ?.apply((e) => e.map((e) => Uri.parse(e as String)).toList());
 }
 
 /// {@template sharedstorage.saf.persistedUriPermissions}

lib/src/saf/uri_permission.dart

@@ -2,7 +2,7 @@
 /// This grants may have been created via `Intent#FLAG_GRANT_READ_URI_PERMISSION`,
 /// etc when sending an `Intent`, or explicitly through `Context#grantUriPermission(String, android.net.Uri, int)`.
 ///
-/// [Refer to details](https://developer.android.com/reference/android/content/UriPermission)
+/// [Refer to details](https://developer.android.com/reference/android/content/UriPermission).
 class UriPermission {
   /// Even we allow create instances of this class avoid it and use
   /// `persistedUriPermissions` API instead
@@ -11,6 +11,7 @@ class UriPermission {
     required this.isWritePermission,
     required this.persistedTime,
     required this.uri,
+    required this.isTreeDocumentFile,
   });
 
   factory UriPermission.fromMap(Map<String, dynamic> map) {
@@ -19,6 +20,7 @@ class UriPermission {
       isWritePermission: map['isWritePermission'] as bool,
       persistedTime: map['persistedTime'] as int,
       uri: Uri.parse(map['uri'] as String),
+      isTreeDocumentFile: map['isTreeDocumentFile'] as bool,
     );
   }
 
@@ -40,24 +42,41 @@ class UriPermission {
   /// [Refer to details](https://android.googlesource.com/platform/frameworks/base/+/master/core/java/android/content/UriPermission.java#56)
   final Uri uri;
 
+  /// Whether or not a tree document file.
+  ///
+  /// Tree document files are granted through [openDocumentTree] method, that is, when the user select a folder-like tree document file.
+  /// Document files are granted through [openDocument] method, that is, when the user select (a) specific(s) document files.
+  ///
+  /// Roughly you may consider it as a property to verify if [this] permission is over a folder or a single-file.
+  final bool isTreeDocumentFile;
+
   @override
   bool operator ==(Object other) =>
       other is UriPermission &&
       isReadPermission == other.isReadPermission &&
       isWritePermission == other.isWritePermission &&
       persistedTime == other.persistedTime &&
-      uri == other.uri;
+      uri == other.uri &&
+      isTreeDocumentFile == other.isTreeDocumentFile;
 
   @override
-  int get hashCode =>
-      Object.hash(isReadPermission, isWritePermission, persistedTime, uri);
+  int get hashCode => Object.hashAll(
+        [
+          isReadPermission,
+          isWritePermission,
+          persistedTime,
+          uri,
+          isTreeDocumentFile,
+        ],
+      );
 
   Map<String, dynamic> toMap() {
     return <String, dynamic>{
       'isReadPermission': isReadPermission,
       'isWritePermission': isWritePermission,
       'persistedTime': persistedTime,
       'uri': '$uri',
+      'isTreeDocumentFile': isTreeDocumentFile,
     };
   }
 
@@ -66,5 +85,6 @@ class UriPermission {
       'isReadPermission: $isReadPermission, '
       'isWritePermission: $isWritePermission, '
       'persistedTime: $persistedTime, '
-      'uri: $uri)';
+      'uri: $uri, '
+      'isTreeDocumentFile: $isTreeDocumentFile)';
 }