pigeon: Add helper binding for copySoundResourceToMediaStore

Author: rajveermalviya

android/app/src/main/kotlin/com/zulip/flutter/Notifications.g.kt

@@ -473,6 +473,23 @@ interface AndroidNotificationHostApi {
    * See: https://developer.android.com/reference/android/content/ContentResolver#query(android.net.Uri,%20java.lang.String[],%20java.lang.String,%20java.lang.String[],%20java.lang.String)
    */
   fun listStoredSoundsInNotificationsDirectory(): List<StoredNotificationsSound>
+  /**
+   * Wraps `android.content.ContentResolver.insert` combined with
+   * `android.content.ContentResolver.openOutputStream` and
+   * `android.content.res.Resources.openRawResource`.
+   *
+   * Copies a raw resource audio file to `Notifications/Zulip/`
+   * directory in device's shared media storage. Returns the uri
+   * of the target file in media store.
+   *
+   * Requires minimum of Android 10 (API 29) or higher.
+   *
+   * See:
+   *   https://developer.android.com/reference/android/content/ContentResolver#insert(android.net.Uri,%20android.content.ContentValues)
+   *   https://developer.android.com/reference/android/content/ContentResolver#openOutputStream(android.net.Uri)
+   *   https://developer.android.com/reference/android/content/res/Resources#openRawResource(int)
+   */
+  fun copySoundResourceToMediaStore(targetFileDisplayName: String, sourceResourceName: String): String
   /**
    * Corresponds to `android.app.NotificationManager.notify`,
    * combined with `androidx.core.app.NotificationCompat.Builder`.
@@ -600,6 +617,24 @@ interface AndroidNotificationHostApi {
           channel.setMessageHandler(null)
         }
       }
+      run {
+        val channel = BasicMessageChannel<Any?>(binaryMessenger, "dev.flutter.pigeon.zulip.AndroidNotificationHostApi.copySoundResourceToMediaStore$separatedMessageChannelSuffix", codec)
+        if (api != null) {
+          channel.setMessageHandler { message, reply ->
+            val args = message as List<Any?>
+            val targetFileDisplayNameArg = args[0] as String
+            val sourceResourceNameArg = args[1] as String
+            val wrapped: List<Any?> = try {
+              listOf(api.copySoundResourceToMediaStore(targetFileDisplayNameArg, sourceResourceNameArg))
+            } catch (exception: Throwable) {
+              wrapError(exception)
+            }
+            reply.reply(wrapped)
+          }
+        } else {
+          channel.setMessageHandler(null)
+        }
+      }
       run {
         val channel = BasicMessageChannel<Any?>(binaryMessenger, "dev.flutter.pigeon.zulip.AndroidNotificationHostApi.notify$separatedMessageChannelSuffix", codec)
         if (api != null) {

android/app/src/main/kotlin/com/zulip/flutter/ZulipPlugin.kt

@@ -2,6 +2,7 @@ package com.zulip.flutter
 
 import android.annotation.SuppressLint
 import android.content.ContentUris
+import android.content.ContentValues
 import android.content.Context
 import android.content.Intent
 import android.os.Build
@@ -48,6 +49,11 @@ fun toPigeonPerson(person: androidx.core.app.Person): Person {
 
 private class AndroidNotificationHost(val context: Context)
         : AndroidNotificationHostApi {
+    // The directory we store our notification sounds into,
+    // expressed as a relative path suitable for:
+    //   https://developer.android.com/reference/kotlin/android/provider/MediaStore.MediaColumns#RELATIVE_PATH:kotlin.String
+    private val notificationSoundsDirectoryPath = "${Environment.DIRECTORY_NOTIFICATIONS}/Zulip/"
+
     override fun createNotificationChannel(channel: NotificationChannel) {
         val notificationChannel = NotificationChannelCompat
             .Builder(channel.id, channel.importance.toInt()).apply {
@@ -78,11 +84,6 @@ private class AndroidNotificationHost(val context: Context)
             throw UnsupportedOperationException()
         }
 
-        // The directory we store our notification sounds into,
-        // expressed as a relative path suitable for:
-        //   https://developer.android.com/reference/kotlin/android/provider/MediaStore.MediaColumns#RELATIVE_PATH:kotlin.String
-        val notificationSoundsDirectoryPath = "${Environment.DIRECTORY_NOTIFICATIONS}/Zulip/"
-
         // Query and cursor-loop based on:
         //   https://developer.android.com/training/data-storage/shared/media#query-collection
         val collection = AudioStore.getContentUri(MediaStore.VOLUME_EXTERNAL_PRIMARY)
@@ -119,6 +120,46 @@ private class AndroidNotificationHost(val context: Context)
         return sounds
     }
 
+    @SuppressLint(
+        // For `getIdentifier`.  TODO make a cleaner API.
+        "DiscouragedApi")
+    override fun copySoundResourceToMediaStore(
+        targetFileDisplayName: String,
+        sourceResourceName: String
+    ): String {
+        if (Build.VERSION.SDK_INT < Build.VERSION_CODES.Q) {
+            throw UnsupportedOperationException()
+        }
+
+        class ResolverFailedException(msg: String) : RuntimeException(msg)
+
+        val resolver = context.contentResolver
+        val collection = AudioStore.getContentUri(MediaStore.VOLUME_EXTERNAL_PRIMARY)
+
+        // Based on: https://developer.android.com/training/data-storage/shared/media#add-item
+        val url = resolver.insert(collection, ContentValues().apply {
+            put(AudioStore.DISPLAY_NAME, targetFileDisplayName)
+            put(AudioStore.RELATIVE_PATH, notificationSoundsDirectoryPath)
+            put(AudioStore.IS_NOTIFICATION, 1)
+            put(AudioStore.IS_PENDING, 1)
+        }) ?: throw ResolverFailedException("resolver.insert failed")
+
+        (resolver.openOutputStream(url, "wt")
+            ?: throw ResolverFailedException("resolver.open… failed"))
+            .use { outputStream ->
+                val resourceId = context.resources.getIdentifier(
+                    sourceResourceName, "raw", context.packageName)
+                context.resources.openRawResource(resourceId)
+                    .use { it.copyTo(outputStream) }
+            }
+
+        resolver.update(
+            url, ContentValues().apply { put(AudioStore.IS_PENDING, 0) },
+            null, null)
+
+        return url.toString()
+    }
+
     @SuppressLint(
         // If permission is missing, `notify` will throw an exception.
         // Which hopefully will propagate to Dart, and then it's up to Dart code to handle it.

lib/host/android_notifications.g.dart

@@ -531,6 +531,47 @@ class AndroidNotificationHostApi {
     }
   }
 
+  /// Wraps `android.content.ContentResolver.insert` combined with
+  /// `android.content.ContentResolver.openOutputStream` and
+  /// `android.content.res.Resources.openRawResource`.
+  ///
+  /// Copies a raw resource audio file to `Notifications/Zulip/`
+  /// directory in device's shared media storage. Returns the uri
+  /// of the target file in media store.
+  ///
+  /// Requires minimum of Android 10 (API 29) or higher.
+  ///
+  /// See:
+  ///   https://developer.android.com/reference/android/content/ContentResolver#insert(android.net.Uri,%20android.content.ContentValues)
+  ///   https://developer.android.com/reference/android/content/ContentResolver#openOutputStream(android.net.Uri)
+  ///   https://developer.android.com/reference/android/content/res/Resources#openRawResource(int)
+  Future<String> copySoundResourceToMediaStore({required String targetFileDisplayName, required String sourceResourceName}) async {
+    final String __pigeon_channelName = 'dev.flutter.pigeon.zulip.AndroidNotificationHostApi.copySoundResourceToMediaStore$__pigeon_messageChannelSuffix';
+    final BasicMessageChannel<Object?> __pigeon_channel = BasicMessageChannel<Object?>(
+      __pigeon_channelName,
+      pigeonChannelCodec,
+      binaryMessenger: __pigeon_binaryMessenger,
+    );
+    final List<Object?>? __pigeon_replyList =
+        await __pigeon_channel.send(<Object?>[targetFileDisplayName, sourceResourceName]) as List<Object?>?;
+    if (__pigeon_replyList == null) {
+      throw _createConnectionError(__pigeon_channelName);
+    } else if (__pigeon_replyList.length > 1) {
+      throw PlatformException(
+        code: __pigeon_replyList[0]! as String,
+        message: __pigeon_replyList[1] as String?,
+        details: __pigeon_replyList[2],
+      );
+    } else if (__pigeon_replyList[0] == null) {
+      throw PlatformException(
+        code: 'null-error',
+        message: 'Host platform returned null value for non-null return value.',
+      );
+    } else {
+      return (__pigeon_replyList[0] as String?)!;
+    }
+  }
+
   /// Corresponds to `android.app.NotificationManager.notify`,
   /// combined with `androidx.core.app.NotificationCompat.Builder`.
   ///

pigeon/notifications.dart

@@ -197,6 +197,22 @@ abstract class AndroidNotificationHostApi {
   /// See: https://developer.android.com/reference/android/content/ContentResolver#query(android.net.Uri,%20java.lang.String[],%20java.lang.String,%20java.lang.String[],%20java.lang.String)
   List<StoredNotificationsSound> listStoredSoundsInNotificationsDirectory();
 
+  /// Wraps `android.content.ContentResolver.insert` combined with
+  /// `android.content.ContentResolver.openOutputStream` and
+  /// `android.content.res.Resources.openRawResource`.
+  ///
+  /// Copies a raw resource audio file to `Notifications/Zulip/`
+  /// directory in device's shared media storage. Returns the uri
+  /// of the target file in media store.
+  ///
+  /// Requires minimum of Android 10 (API 29) or higher.
+  ///
+  /// See:
+  ///   https://developer.android.com/reference/android/content/ContentResolver#insert(android.net.Uri,%20android.content.ContentValues)
+  ///   https://developer.android.com/reference/android/content/ContentResolver#openOutputStream(android.net.Uri)
+  ///   https://developer.android.com/reference/android/content/res/Resources#openRawResource(int)
+  String copySoundResourceToMediaStore({required String targetFileDisplayName, required String sourceResourceName});
+
   /// Corresponds to `android.app.NotificationManager.notify`,
   /// combined with `androidx.core.app.NotificationCompat.Builder`.
   ///

test/model/binding.dart

@@ -588,8 +588,14 @@ class FakeAndroidNotificationHostApi implements AndroidNotificationHostApi {
     _activeChannels.remove(channelId);
   }
 
+  /// Generates a fake uri for a notification sound present in media store.
+  String fakeStoredNotificationSoundUri(String resourceName) {
+    return 'content://media/external_primary/audio/media/$resourceName';
+  }
+
   final _storedNotificationSounds = <StoredNotificationsSound>[];
 
+  /// Populates the media store with the provided entries.
   void setupStoredNotificationSounds(List<StoredNotificationsSound> sounds) {
     _storedNotificationSounds.addAll(sounds);
   }
@@ -599,6 +605,34 @@ class FakeAndroidNotificationHostApi implements AndroidNotificationHostApi {
     return _storedNotificationSounds;
   }
 
+  /// Consume the log of calls made to [copySoundResourceToMediaStore].
+  ///
+  /// This returns a list of the arguments to all calls made
+  /// to [copySoundResourceToMediaStore] since the last call to this method.
+  List<CopySoundResourceToMediaStoreCall> takeCopySoundResourceToMediaStoreCalls() {
+    final result = _copySoundResourceToMediaStoreCalls;
+    _copySoundResourceToMediaStoreCalls = [];
+    return result;
+  }
+  List<CopySoundResourceToMediaStoreCall> _copySoundResourceToMediaStoreCalls = [];
+
+  @override
+  Future<String> copySoundResourceToMediaStore({
+    required String targetFileDisplayName,
+    required String sourceResourceName,
+  }) async {
+    _copySoundResourceToMediaStoreCalls.add((
+      targetFileDisplayName: targetFileDisplayName,
+      sourceResourceName: sourceResourceName));
+
+    final uri = fakeStoredNotificationSoundUri(sourceResourceName);
+    _storedNotificationSounds.add(StoredNotificationsSound(
+      fileName: targetFileDisplayName,
+      isOwner: true,
+      uri: uri));
+    return uri;
+  }
+
   /// Consume the log of calls made to [notify].
   ///
   /// This returns a list of the arguments to all calls made
@@ -721,3 +755,8 @@ typedef AndroidNotificationHostApiNotifyCall = ({
   int? number,
   String? smallIconResourceName,
 });
+
+typedef CopySoundResourceToMediaStoreCall = ({
+  String targetFileDisplayName,
+  String sourceResourceName,
+});