Merge pull request #9318 from JosJuice/android-saf-games

Android: Use storage access framework for game list

Source/Android/jni/AndroidCommon/AndroidCommon.cpp

@@ -4,6 +4,7 @@
 
 #include "jni/AndroidCommon/AndroidCommon.h"
 
+#include <ios>
 #include <string>
 #include <string_view>
 #include <vector>
@@ -43,6 +44,14 @@ std::vector<std::string> JStringArrayToVector(JNIEnv* env, jobjectArray array)
   return result;
 }
 
+jobjectArray JStringArrayFromVector(JNIEnv* env, std::vector<std::string> vector)
+{
+  jobjectArray result = env->NewObjectArray(vector.size(), IDCache::GetStringClass(), nullptr);
+  for (jsize i = 0; i < vector.size(); ++i)
+    env->SetObjectArrayElement(result, i, ToJString(env, vector[i]));
+  return result;
+}
+
 bool IsPathAndroidContent(const std::string& uri)
 {
   return StringBeginsWith(uri, "content://");
@@ -66,6 +75,28 @@ std::string OpenModeToAndroid(std::string mode)
   return mode;
 }
 
+std::string OpenModeToAndroid(std::ios_base::openmode mode)
+{
+  std::string result;
+
+  if (mode & std::ios_base::in)
+    result += 'r';
+
+  if (mode & (std::ios_base::out | std::ios_base::app))
+    result += 'w';
+
+  if (mode & std::ios_base::app)
+    result += 'a';
+
+  constexpr std::ios_base::openmode t = std::ios_base::in | std::ios_base::trunc;
+  if ((mode & t) == t)
+    result += 't';
+
+  // The 'b' specifier is not supported. Since we're on POSIX, it's fine to just skip it.
+
+  return result;
+}
+
 int OpenAndroidContent(const std::string& uri, const std::string& mode)
 {
   JNIEnv* env = IDCache::GetEnvForThread();
@@ -81,6 +112,43 @@ bool DeleteAndroidContent(const std::string& uri)
                                       IDCache::GetContentHandlerDelete(), ToJString(env, uri));
 }
 
+jlong GetAndroidContentSizeAndIsDirectory(const std::string& uri)
+{
+  JNIEnv* env = IDCache::GetEnvForThread();
+  return env->CallStaticLongMethod(IDCache::GetContentHandlerClass(),
+                                   IDCache::GetContentHandlerGetSizeAndIsDirectory(),
+                                   ToJString(env, uri));
+}
+
+std::string GetAndroidContentDisplayName(const std::string& uri)
+{
+  JNIEnv* env = IDCache::GetEnvForThread();
+  jobject display_name =
+      env->CallStaticObjectMethod(IDCache::GetContentHandlerClass(),
+                                  IDCache::GetContentHandlerGetDisplayName(), ToJString(env, uri));
+  return display_name ? GetJString(env, reinterpret_cast<jstring>(display_name)) : "";
+}
+
+std::vector<std::string> GetAndroidContentChildNames(const std::string& uri)
+{
+  JNIEnv* env = IDCache::GetEnvForThread();
+  jobject children = env->CallStaticObjectMethod(IDCache::GetContentHandlerClass(),
+                                                 IDCache::GetContentHandlerGetChildNames(),
+                                                 ToJString(env, uri), false);
+  return JStringArrayToVector(env, reinterpret_cast<jobjectArray>(children));
+}
+
+std::vector<std::string> DoFileSearchAndroidContent(const std::string& directory,
+                                                    const std::vector<std::string>& extensions,
+                                                    bool recursive)
+{
+  JNIEnv* env = IDCache::GetEnvForThread();
+  jobject result = env->CallStaticObjectMethod(
+      IDCache::GetContentHandlerClass(), IDCache::GetContentHandlerDoFileSearch(),
+      ToJString(env, directory), JStringArrayFromVector(env, extensions), recursive);
+  return JStringArrayToVector(env, reinterpret_cast<jobjectArray>(result));
+}
+
 int GetNetworkIpAddress()
 {
   JNIEnv* env = IDCache::GetEnvForThread();

Source/Android/jni/AndroidCommon/AndroidCommon.h

@@ -4,7 +4,9 @@
 
 #pragma once
 
+#include <ios>
 #include <string>
+#include <vector>
 
 #include <jni.h>
 
@@ -17,12 +19,29 @@ bool IsPathAndroidContent(const std::string& uri);
 
 // Turns a C/C++ style mode (e.g. "rb") into one which can be used with OpenAndroidContent.
 std::string OpenModeToAndroid(std::string mode);
+std::string OpenModeToAndroid(std::ios_base::openmode mode);
 
 // Opens a given file and returns a file descriptor.
 int OpenAndroidContent(const std::string& uri, const std::string& mode);
 
 // Deletes a given file.
 bool DeleteAndroidContent(const std::string& uri);
+// Returns -1 if not found, -2 if directory, file size otherwise.
+jlong GetAndroidContentSizeAndIsDirectory(const std::string& uri);
+
+// An unmangled URI (one which the C++ code has not appended anything to) can't be relied on
+// to contain a file name at all. If a file name is desired, this function is the most reliable
+// way to get it, but the display name is not guaranteed to always actually be like a file name.
+// An empty string will be returned for files which do not exist.
+std::string GetAndroidContentDisplayName(const std::string& uri);
+
+// Returns the display names of all children of a directory, non-recursively.
+std::vector<std::string> GetAndroidContentChildNames(const std::string& uri);
+
+std::vector<std::string> DoFileSearchAndroidContent(const std::string& directory,
+                                                    const std::vector<std::string>& extensions,
+                                                    bool recursive);
+
 int GetNetworkIpAddress();
 int GetNetworkPrefixLength();
 int GetNetworkGateway();

Source/Android/jni/AndroidCommon/IDCache.cpp

@@ -10,6 +10,8 @@ static constexpr jint JNI_VERSION = JNI_VERSION_1_6;
 
 static JavaVM* s_java_vm;
 
+static jclass s_string_class;
+
 static jclass s_native_library_class;
 static jmethodID s_display_alert_msg;
 static jmethodID s_do_rumble;
@@ -44,6 +46,10 @@ static jmethodID s_compress_cb_run;
 static jclass s_content_handler_class;
 static jmethodID s_content_handler_open_fd;
 static jmethodID s_content_handler_delete;
+static jmethodID s_content_handler_get_size_and_is_directory;
+static jmethodID s_content_handler_get_display_name;
+static jmethodID s_content_handler_get_child_names;
+static jmethodID s_content_handler_do_file_search;
 
 static jclass s_network_helper_class;
 static jmethodID s_network_helper_get_network_ip_address;
@@ -75,6 +81,11 @@ JNIEnv* GetEnvForThread()
   return owned.env;
 }
 
+jclass GetStringClass()
+{
+  return s_string_class;
+}
+
 jclass GetNativeLibraryClass()
 {
   return s_native_library_class;
@@ -210,6 +221,26 @@ jmethodID GetContentHandlerDelete()
   return s_content_handler_delete;
 }
 
+jmethodID GetContentHandlerGetSizeAndIsDirectory()
+{
+  return s_content_handler_get_size_and_is_directory;
+}
+
+jmethodID GetContentHandlerGetDisplayName()
+{
+  return s_content_handler_get_display_name;
+}
+
+jmethodID GetContentHandlerGetChildNames()
+{
+  return s_content_handler_get_child_names;
+}
+
+jmethodID GetContentHandlerDoFileSearch()
+{
+  return s_content_handler_do_file_search;
+}
+
 jclass GetNetworkHelperClass()
 {
   return s_network_helper_class;
@@ -229,6 +260,7 @@ jmethodID GetNetworkHelperGetNetworkGateway()
 {
   return s_network_helper_get_network_gateway;
 }
+
 }  // namespace IDCache
 
 #ifdef __cplusplus
@@ -243,6 +275,9 @@ jint JNI_OnLoad(JavaVM* vm, void* reserved)
   if (vm->GetEnv(reinterpret_cast<void**>(&env), JNI_VERSION) != JNI_OK)
     return JNI_ERR;
 
+  const jclass string_class = env->FindClass("java/lang/String");
+  s_string_class = reinterpret_cast<jclass>(env->NewGlobalRef(string_class));
+
   const jclass native_library_class = env->FindClass("org/dolphinemu/dolphinemu/NativeLibrary");
   s_native_library_class = reinterpret_cast<jclass>(env->NewGlobalRef(native_library_class));
   s_display_alert_msg = env->GetStaticMethodID(s_native_library_class, "displayAlertMsg",
@@ -306,6 +341,15 @@ jint JNI_OnLoad(JavaVM* vm, void* reserved)
                                                      "(Ljava/lang/String;Ljava/lang/String;)I");
   s_content_handler_delete =
       env->GetStaticMethodID(s_content_handler_class, "delete", "(Ljava/lang/String;)Z");
+  s_content_handler_get_size_and_is_directory = env->GetStaticMethodID(
+      s_content_handler_class, "getSizeAndIsDirectory", "(Ljava/lang/String;)J");
+  s_content_handler_get_display_name = env->GetStaticMethodID(
+      s_content_handler_class, "getDisplayName", "(Ljava/lang/String;)Ljava/lang/String;");
+  s_content_handler_get_child_names = env->GetStaticMethodID(
+      s_content_handler_class, "getChildNames", "(Ljava/lang/String;Z)[Ljava/lang/String;");
+  s_content_handler_do_file_search =
+      env->GetStaticMethodID(s_content_handler_class, "doFileSearch",
+                             "(Ljava/lang/String;[Ljava/lang/String;Z)[Ljava/lang/String;");
 
   const jclass network_helper_class =
       env->FindClass("org/dolphinemu/dolphinemu/utils/NetworkHelper");

Source/Android/jni/AndroidCommon/IDCache.h

@@ -10,6 +10,8 @@ namespace IDCache
 {
 JNIEnv* GetEnvForThread();
 
+jclass GetStringClass();
+
 jclass GetNativeLibraryClass();
 jmethodID GetDisplayAlertMsg();
 jmethodID GetDoRumble();
@@ -44,6 +46,10 @@ jmethodID GetCompressCallbackRun();
 jclass GetContentHandlerClass();
 jmethodID GetContentHandlerOpenFd();
 jmethodID GetContentHandlerDelete();
+jmethodID GetContentHandlerGetSizeAndIsDirectory();
+jmethodID GetContentHandlerGetDisplayName();
+jmethodID GetContentHandlerGetChildNames();
+jmethodID GetContentHandlerDoFileSearch();
 
 jclass GetNetworkHelperClass();
 jmethodID GetNetworkHelperGetNetworkIpAddress();