pigeon: Add a helper binding for listStoredSoundsInNotificationsDirectory

Author: rajveermalviya

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

@@ -345,6 +345,47 @@ data class StatusBarNotification (
     )
   }
 }
+
+/**
+ * Represents details about a notification sound stored in the
+ * shared media store.
+ *
+ * Returned as a list entry by
+ * [AndroidNotificationHostApi.listStoredSoundsInNotificationsDirectory].
+ *
+ * Generated class from Pigeon that represents data sent in messages.
+ */
+data class StoredNotificationSound (
+  /** The display name of the sound file. */
+  val fileName: String,
+  /**
+   * Specifies whether this file was created by the app.
+   *
+   * It is true if the `MediaStore.Audio.Media.OWNER_PACKAGE_NAME` key in the
+   * metadata matches the app's package name.
+   */
+  val isOwned: Boolean,
+  /** A `content://…` URL pointing to the sound file. */
+  val contentUrl: String
+
+) {
+  companion object {
+    @Suppress("LocalVariableName")
+    fun fromList(__pigeon_list: List<Any?>): StoredNotificationSound {
+      val fileName = __pigeon_list[0] as String
+      val isOwned = __pigeon_list[1] as Boolean
+      val contentUrl = __pigeon_list[2] as String
+      return StoredNotificationSound(fileName, isOwned, contentUrl)
+    }
+  }
+  fun toList(): List<Any?> {
+    return listOf(
+      fileName,
+      isOwned,
+      contentUrl,
+    )
+  }
+}
 private object NotificationsPigeonCodec : StandardMessageCodec() {
   override fun readValueOfType(type: Byte, buffer: ByteBuffer): Any? {
     return when (type) {
@@ -393,6 +434,11 @@ private object NotificationsPigeonCodec : StandardMessageCodec() {
           StatusBarNotification.fromList(it)
         }
       }
+      138.toByte() -> {
+        return (readValue(buffer) as? List<Any?>)?.let {
+          StoredNotificationSound.fromList(it)
+        }
+      }
       else -> super.readValueOfType(type, buffer)
     }
   }
@@ -434,6 +480,10 @@ private object NotificationsPigeonCodec : StandardMessageCodec() {
         stream.write(137)
         writeValue(stream, value.toList())
       }
+      is StoredNotificationSound -> {
+        stream.write(138)
+        writeValue(stream, value.toList())
+      }
       else -> super.writeValue(stream, value)
     }
   }
@@ -459,6 +509,19 @@ interface AndroidNotificationHostApi {
    * See: https://developer.android.com/reference/kotlin/androidx/core/app/NotificationManagerCompat#deleteNotificationChannel(java.lang.String)
    */
   fun deleteNotificationChannel(channelId: String)
+  /**
+   * The list of notification sound files present under `Notifications/Zulip/`
+   * in the device's shared media storage,
+   * found with `android.content.ContentResolver.query`.
+   *
+   * This is a complex ad-hoc method.
+   * For detailed behavior, see its implementation.
+   *
+   * Requires minimum of Android 10 (API 29) or higher.
+   *
+   * 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<StoredNotificationSound>
   /**
    * Corresponds to `android.app.NotificationManager.notify`,
    * combined with `androidx.core.app.NotificationCompat.Builder`.
@@ -571,6 +634,21 @@ interface AndroidNotificationHostApi {
           channel.setMessageHandler(null)
         }
       }
+      run {
+        val channel = BasicMessageChannel<Any?>(binaryMessenger, "dev.flutter.pigeon.zulip.AndroidNotificationHostApi.listStoredSoundsInNotificationsDirectory$separatedMessageChannelSuffix", codec)
+        if (api != null) {
+          channel.setMessageHandler { _, reply ->
+            val wrapped: List<Any?> = try {
+              listOf(api.listStoredSoundsInNotificationsDirectory())
+            } 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

@@ -1,10 +1,15 @@
 package com.zulip.flutter
 
 import android.annotation.SuppressLint
+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.os.Environment
+import android.provider.MediaStore
+import android.provider.MediaStore.Audio.Media as AudioStore
 import android.util.Log
 import androidx.annotation.Keep
 import androidx.core.app.NotificationChannelCompat
@@ -69,6 +74,54 @@ private class AndroidNotificationHost(val context: Context)
         NotificationManagerCompat.from(context).deleteNotificationChannel(channelId)
     }
 
+    override fun listStoredSoundsInNotificationsDirectory(): List<StoredNotificationSound> {
+        if (Build.VERSION.SDK_INT < Build.VERSION_CODES.Q) {
+            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/"
+
+        class ResolverFailedException(msg: String) : RuntimeException(msg)
+
+        // 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)
+        val projection = arrayOf(AudioStore._ID, AudioStore.DISPLAY_NAME, AudioStore.OWNER_PACKAGE_NAME)
+        val selection = "${AudioStore.RELATIVE_PATH}=?"
+        val selectionArgs = arrayOf(notificationSoundsDirectoryPath)
+        val sortOrder = "${AudioStore._ID} ASC"
+
+        val sounds = mutableListOf<StoredNotificationSound>()
+        val cursor = context.contentResolver.query(
+            collection,
+            projection,
+            selection,
+            selectionArgs,
+            sortOrder,
+        ) ?: throw ResolverFailedException("resolver.query failed")
+        cursor.use {
+            val idColumn = cursor.getColumnIndexOrThrow(AudioStore._ID)
+            val nameColumn = cursor.getColumnIndexOrThrow(AudioStore.DISPLAY_NAME)
+            val ownerColumn = cursor.getColumnIndexOrThrow(AudioStore.OWNER_PACKAGE_NAME)
+            while (cursor.moveToNext()) {
+                val id = cursor.getLong(idColumn)
+                val fileName = cursor.getString(nameColumn)
+                val ownerPackageName = cursor.getString(ownerColumn)
+
+                val contentUrl = ContentUris.withAppendedId(collection, id)
+                sounds.add(StoredNotificationSound(
+                    fileName = fileName,
+                    isOwned = context.packageName == ownerPackageName,
+                    contentUrl = contentUrl.toString()
+                ))
+            }
+        }
+        return sounds
+    }
+
     @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

@@ -338,6 +338,48 @@ class StatusBarNotification {
   }
 }
 
+/// Represents details about a notification sound stored in the
+/// shared media store.
+///
+/// Returned as a list entry by
+/// [AndroidNotificationHostApi.listStoredSoundsInNotificationsDirectory].
+class StoredNotificationSound {
+  StoredNotificationSound({
+    required this.fileName,
+    required this.isOwned,
+    required this.contentUrl,
+  });
+
+  /// The display name of the sound file.
+  String fileName;
+
+  /// Specifies whether this file was created by the app.
+  ///
+  /// It is true if the `MediaStore.Audio.Media.OWNER_PACKAGE_NAME` key in the
+  /// metadata matches the app's package name.
+  bool isOwned;
+
+  /// A `content://…` URL pointing to the sound file.
+  String contentUrl;
+
+  Object encode() {
+    return <Object?>[
+      fileName,
+      isOwned,
+      contentUrl,
+    ];
+  }
+
+  static StoredNotificationSound decode(Object result) {
+    result as List<Object?>;
+    return StoredNotificationSound(
+      fileName: result[0]! as String,
+      isOwned: result[1]! as bool,
+      contentUrl: result[2]! as String,
+    );
+  }
+}
+
 
 class _PigeonCodec extends StandardMessageCodec {
   const _PigeonCodec();
@@ -370,6 +412,9 @@ class _PigeonCodec extends StandardMessageCodec {
     } else     if (value is StatusBarNotification) {
       buffer.putUint8(137);
       writeValue(buffer, value.encode());
+    } else     if (value is StoredNotificationSound) {
+      buffer.putUint8(138);
+      writeValue(buffer, value.encode());
     } else {
       super.writeValue(buffer, value);
     }
@@ -396,6 +441,8 @@ class _PigeonCodec extends StandardMessageCodec {
         return Notification.decode(readValue(buffer)!);
       case 137: 
         return StatusBarNotification.decode(readValue(buffer)!);
+      case 138: 
+        return StoredNotificationSound.decode(readValue(buffer)!);
       default:
         return super.readValueOfType(type, buffer);
     }
@@ -495,6 +542,43 @@ class AndroidNotificationHostApi {
     }
   }
 
+  /// The list of notification sound files present under `Notifications/Zulip/`
+  /// in the device's shared media storage,
+  /// found with `android.content.ContentResolver.query`.
+  ///
+  /// This is a complex ad-hoc method.
+  /// For detailed behavior, see its implementation.
+  ///
+  /// Requires minimum of Android 10 (API 29) or higher.
+  ///
+  /// 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)
+  Future<List<StoredNotificationSound?>> listStoredSoundsInNotificationsDirectory() async {
+    final String __pigeon_channelName = 'dev.flutter.pigeon.zulip.AndroidNotificationHostApi.listStoredSoundsInNotificationsDirectory$__pigeon_messageChannelSuffix';
+    final BasicMessageChannel<Object?> __pigeon_channel = BasicMessageChannel<Object?>(
+      __pigeon_channelName,
+      pigeonChannelCodec,
+      binaryMessenger: __pigeon_binaryMessenger,
+    );
+    final List<Object?>? __pigeon_replyList =
+        await __pigeon_channel.send(null) 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 List<Object?>?)!.cast<StoredNotificationSound?>();
+    }
+  }
+
   /// Corresponds to `android.app.NotificationManager.notify`,
   /// combined with `androidx.core.app.NotificationCompat.Builder`.
   ///

pigeon/notifications.dart

@@ -164,6 +164,31 @@ class StatusBarNotification {
   // Various other properties too; add them if needed.
 }
 
+/// Represents details about a notification sound stored in the
+/// shared media store.
+///
+/// Returned as a list entry by
+/// [AndroidNotificationHostApi.listStoredSoundsInNotificationsDirectory].
+class StoredNotificationSound {
+  StoredNotificationSound({
+    required this.fileName,
+    required this.isOwned,
+    required this.contentUrl,
+  });
+
+  /// The display name of the sound file.
+  final String fileName;
+
+  /// Specifies whether this file was created by the app.
+  ///
+  /// It is true if the `MediaStore.Audio.Media.OWNER_PACKAGE_NAME` key in the
+  /// metadata matches the app's package name.
+  final bool isOwned;
+
+  /// A `content://…` URL pointing to the sound file.
+  final String contentUrl;
+}
+
 @HostApi()
 abstract class AndroidNotificationHostApi {
   /// Corresponds to `androidx.core.app.NotificationManagerCompat.createNotificationChannel`.
@@ -181,6 +206,18 @@ abstract class AndroidNotificationHostApi {
   /// See: https://developer.android.com/reference/kotlin/androidx/core/app/NotificationManagerCompat#deleteNotificationChannel(java.lang.String)
   void deleteNotificationChannel(String channelId);
 
+  /// The list of notification sound files present under `Notifications/Zulip/`
+  /// in the device's shared media storage,
+  /// found with `android.content.ContentResolver.query`.
+  ///
+  /// This is a complex ad-hoc method.
+  /// For detailed behavior, see its implementation.
+  ///
+  /// Requires minimum of Android 10 (API 29) or higher.
+  ///
+  /// 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<StoredNotificationSound> listStoredSoundsInNotificationsDirectory();
+
   /// Corresponds to `android.app.NotificationManager.notify`,
   /// combined with `androidx.core.app.NotificationCompat.Builder`.
   ///

test/model/binding.dart

@@ -553,6 +553,18 @@ class FakeAndroidNotificationHostApi implements AndroidNotificationHostApi {
     _activeChannels.remove(channelId);
   }
 
+  final _storedNotificationSounds = <StoredNotificationSound>[];
+
+  /// Populates the media store with the provided entries.
+  void setupStoredNotificationSounds(List<StoredNotificationSound> sounds) {
+    _storedNotificationSounds.addAll(sounds);
+  }
+
+  @override
+  Future<List<StoredNotificationSound?>> listStoredSoundsInNotificationsDirectory() async {
+    return _storedNotificationSounds.toList(growable: false);
+  }
+
   /// Consume the log of calls made to [notify].
   ///
   /// This returns a list of the arguments to all calls made