141 changes: 94 additions & 47 deletions ...ce/Android/app/src/main/java/org/dolphinemu/dolphinemu/utils/DirectoryInitialization.java
View file
Expand Up @@ -13,6 +13,7 @@
import android.preference.PreferenceManager;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.localbroadcastmanager.content.LocalBroadcastManager;

import org.dolphinemu.dolphinemu.NativeLibrary;
Expand Down Expand Up @@ -42,12 +43,12 @@
private static volatile boolean areDirectoriesAvailable = false;
private static String userPath;
private static AtomicBoolean isDolphinDirectoryInitializationRunning = new AtomicBoolean(false);
private static boolean isUsingLegacyUserDirectory = false;

public enum DirectoryInitializationState
{
NOT_YET_INITIALIZED,
DOLPHIN_DIRECTORIES_INITIALIZED,
EXTERNAL_STORAGE_PERMISSION_NEEDED,
CANT_FIND_EXTERNAL_STORAGE
}

Expand All @@ -65,51 +66,60 @@ private static void init(Context context)
{
if (directoryState != DirectoryInitializationState.DOLPHIN_DIRECTORIES_INITIALIZED)
{
if (PermissionsHandler.hasWriteAccess(context))
if (setDolphinUserDirectory(context))
{
if (setDolphinUserDirectory(context))
{
initializeInternalStorage(context);
boolean wiimoteIniWritten = initializeExternalStorage(context);
NativeLibrary.Initialize();
NativeLibrary.ReportStartToAnalytics();

areDirectoriesAvailable = true;
initializeInternalStorage(context);
boolean wiimoteIniWritten = initializeExternalStorage(context);
NativeLibrary.Initialize();
NativeLibrary.ReportStartToAnalytics();

if (wiimoteIniWritten)
{
// This has to be done after calling NativeLibrary.Initialize(),
// as it relies on the config system
EmulationActivity.updateWiimoteNewIniPreferences(context);
}
areDirectoriesAvailable = true;

directoryState = DirectoryInitializationState.DOLPHIN_DIRECTORIES_INITIALIZED;
}
else
if (wiimoteIniWritten)
{
directoryState = DirectoryInitializationState.CANT_FIND_EXTERNAL_STORAGE;
// This has to be done after calling NativeLibrary.Initialize(),
// as it relies on the config system
EmulationActivity.updateWiimoteNewIniPreferences(context);
}

directoryState = DirectoryInitializationState.DOLPHIN_DIRECTORIES_INITIALIZED;
}
else
{
directoryState = DirectoryInitializationState.EXTERNAL_STORAGE_PERMISSION_NEEDED;
directoryState = DirectoryInitializationState.CANT_FIND_EXTERNAL_STORAGE;
}
}

isDolphinDirectoryInitializationRunning.set(false);
sendBroadcastState(directoryState, context);
}

@Nullable
private static File getLegacyUserDirectoryPath()
{
File externalPath = Environment.getExternalStorageDirectory();
if (externalPath == null)
return null;

return new File(externalPath, "dolphin-emu");
}

private static boolean setDolphinUserDirectory(Context context)
{
if (!Environment.MEDIA_MOUNTED.equals(Environment.getExternalStorageState()))
return false;

File externalPath = Environment.getExternalStorageDirectory();
if (externalPath == null)
isUsingLegacyUserDirectory =
preferLegacyUserDirectory(context) && PermissionsHandler.hasWriteAccess(context);

File path = isUsingLegacyUserDirectory ?
getLegacyUserDirectoryPath() : context.getExternalFilesDir(null);

if (path == null)
return false;

userPath = externalPath.getAbsolutePath() + "/dolphin-emu";
userPath = path.getAbsolutePath();

Log.debug("[DirectoryInitialization] User Dir: " + userPath);
NativeLibrary.SetUserDirectory(userPath);

Expand Down Expand Up @@ -207,25 +217,18 @@ private static void deleteDirectoryRecursively(@NonNull final File file)
public static boolean shouldStart(Context context)
{
return !isDolphinDirectoryInitializationRunning.get() &&
getDolphinDirectoriesState(context) == DirectoryInitializationState.NOT_YET_INITIALIZED;
getDolphinDirectoriesState() == DirectoryInitializationState.NOT_YET_INITIALIZED &&
!isWaitingForWriteAccess(context);
}

public static boolean areDolphinDirectoriesReady()
{
return directoryState == DirectoryInitializationState.DOLPHIN_DIRECTORIES_INITIALIZED;
}

public static DirectoryInitializationState getDolphinDirectoriesState(Context context)
public static DirectoryInitializationState getDolphinDirectoriesState()
{
if (directoryState == DirectoryInitializationState.NOT_YET_INITIALIZED &&
!PermissionsHandler.hasWriteAccess(context))
{
return DirectoryInitializationState.EXTERNAL_STORAGE_PERMISSION_NEEDED;
}
else
{
return directoryState;
}
return directoryState;
}

public static String getUserDirectory()
Expand Down Expand Up @@ -335,28 +338,72 @@ private static void createWiimoteProfileDirectory(String directory)
}
}

public static boolean isExternalStorageLegacy()
{
return Build.VERSION.SDK_INT < Build.VERSION_CODES.Q || Environment.isExternalStorageLegacy();
}

public static boolean preferOldFolderPicker(Context context)
{
// As of January 2021, ACTION_OPEN_DOCUMENT_TREE seems to be broken on the Nvidia Shield TV
// (the activity can't be navigated correctly with a gamepad). We can use the old folder picker
// for the time being - Android 11 hasn't been released for this device. We have an explicit
// check for Android 11 below in hopes that Nvidia will fix this before releasing Android 11.
//
// No Android TV device other than the Nvidia Shield TV is known to have an implementation
// of ACTION_OPEN_DOCUMENT or ACTION_OPEN_DOCUMENT_TREE that even launches, but "fortunately"
// for us, the Nvidia Shield TV is the only Android TV device in existence so far that can
// run Dolphin at all (due to the 64-bit requirement), so we can ignore this problem.
// No Android TV device other than the Nvidia Shield TV is known to have an implementation of
// ACTION_OPEN_DOCUMENT or ACTION_OPEN_DOCUMENT_TREE that even launches, but "fortunately", no
// Android TV device other than the Shield TV is known to be able to run Dolphin (either due to
// the 64-bit requirement or due to the GLES 3.0 requirement), so we can ignore this problem.
//
// All phones which are running a compatible version of Android support ACTION_OPEN_DOCUMENT and
// ACTION_OPEN_DOCUMENT_TREE, as this is required by the Android CTS (unlike with Android TV).
// ACTION_OPEN_DOCUMENT_TREE, as this is required by the mobile Android CTS (unlike Android TV).

return Build.VERSION.SDK_INT < Build.VERSION_CODES.R &&
PermissionsHandler.isExternalStorageLegacy() && TvUtil.isLeanback(context);
}

private static boolean isExternalFilesDirEmpty(Context context)
{
File dir = context.getExternalFilesDir(null);
if (dir == null)
return false; // External storage not available

File[] contents = dir.listFiles();
return contents == null || contents.length == 0;
}

private static boolean legacyUserDirectoryExists()
{
try
{
return getLegacyUserDirectoryPath().exists();
}
catch (SecurityException e)
{
// Most likely we don't have permission to read external storage.
// Return true so that external storage permissions will be requested.
//
// Strangely, we don't seem to trigger this case in practice, even with no permissions...
// But this only makes things more convenient for users, so no harm done.

return true;
}
}

private static boolean preferLegacyUserDirectory(Context context)
{
return PermissionsHandler.isExternalStorageLegacy() &&
!PermissionsHandler.isWritePermissionDenied() &&
isExternalFilesDirEmpty(context) && legacyUserDirectoryExists();
}

public static boolean isUsingLegacyUserDirectory()
{
return isUsingLegacyUserDirectory;
}

public static boolean isWaitingForWriteAccess(Context context)
{
// This first check is only for performance, not correctness
if (getDolphinDirectoriesState() != DirectoryInitializationState.NOT_YET_INITIALIZED)
return false;

return Build.VERSION.SDK_INT < Build.VERSION_CODES.R && isExternalStorageLegacy() &&
TvUtil.isLeanback(context);
return preferLegacyUserDirectory(context) && !PermissionsHandler.hasWriteAccess(context);
}

private static native void CreateUserDirectories();
Expand Down
49 changes: 26 additions & 23 deletions Source/Android/app/src/main/java/org/dolphinemu/dolphinemu/utils/PermissionsHandler.java
View file
Expand Up @@ -2,10 +2,10 @@

package org.dolphinemu.dolphinemu.utils;

import android.annotation.TargetApi;
import android.content.Context;
import android.content.pm.PackageManager;
import android.os.Build;
import android.os.Environment;

import androidx.core.content.ContextCompat;
import androidx.fragment.app.FragmentActivity;
Expand All @@ -15,38 +15,41 @@
public class PermissionsHandler
{
public static final int REQUEST_CODE_WRITE_PERMISSION = 500;
private static boolean sWritePermissionDenied = false;

@TargetApi(Build.VERSION_CODES.M)
public static boolean checkWritePermission(final FragmentActivity activity)
public static void requestWritePermission(final FragmentActivity activity)
{
if (android.os.Build.VERSION.SDK_INT < Build.VERSION_CODES.M)
{
return true;
}
return;

activity.requestPermissions(new String[]{WRITE_EXTERNAL_STORAGE},
REQUEST_CODE_WRITE_PERMISSION);
}

int hasWritePermission = ContextCompat.checkSelfPermission(activity, WRITE_EXTERNAL_STORAGE);
public static boolean hasWriteAccess(Context context)
{
if (android.os.Build.VERSION.SDK_INT < Build.VERSION_CODES.M)
return true;

if (hasWritePermission != PackageManager.PERMISSION_GRANTED)
{
// We only care about displaying the "Don't ask again" check and can ignore the result.
// Previous toasts already explained the rationale.
activity.shouldShowRequestPermissionRationale(WRITE_EXTERNAL_STORAGE);
activity.requestPermissions(new String[]{WRITE_EXTERNAL_STORAGE},
REQUEST_CODE_WRITE_PERMISSION);
if (!isExternalStorageLegacy())
return false;
}

return true;
int hasWritePermission = ContextCompat.checkSelfPermission(context, WRITE_EXTERNAL_STORAGE);
return hasWritePermission == PackageManager.PERMISSION_GRANTED;
}

public static boolean hasWriteAccess(Context context)
public static boolean isExternalStorageLegacy()
{
return Build.VERSION.SDK_INT < Build.VERSION_CODES.Q || Environment.isExternalStorageLegacy();
}

public static void setWritePermissionDenied()
{
if (android.os.Build.VERSION.SDK_INT >= Build.VERSION_CODES.M)
{
int hasWritePermission = ContextCompat.checkSelfPermission(context, WRITE_EXTERNAL_STORAGE);
return hasWritePermission == PackageManager.PERMISSION_GRANTED;
}
sWritePermissionDenied = true;
}

return true;
public static boolean isWritePermissionDenied()
{
return sWritePermissionDenied;
}
}
5 changes: 3 additions & 2 deletions Source/Android/app/src/main/java/org/dolphinemu/dolphinemu/utils/StartupHandler.java
View file
Expand Up @@ -22,8 +22,9 @@

public static void HandleInit(FragmentActivity parent)
{
// Ask the user to grant write permission if it's not already granted
PermissionsHandler.checkWritePermission(parent);
// Ask the user to grant write permission if relevant and not already granted
if (DirectoryInitialization.isWaitingForWriteAccess(parent))
PermissionsHandler.requestWritePermission(parent);

// Ask the user if he wants to enable analytics if we haven't yet.
Analytics.checkAnalyticsInit(parent);
Expand Down
56 changes: 56 additions & 0 deletions Source/Android/app/src/main/res/layout/activity_user_data.xml
View file
@@ -0,0 +1,56 @@
<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent">

<TextView
android:id="@+id/text_type"
android:layout_width="0dp"
android:layout_height="wrap_content"
android:layout_margin="@dimen/spacing_medlarge"
tools:text="@string/user_data_new_location"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintEnd_toEndOf="parent"
app:layout_constraintTop_toTopOf="parent"
app:layout_constraintBottom_toTopOf="@id/text_path"
app:layout_constraintVertical_chainStyle="packed"
app:layout_constraintWidth_max="400dp"/>

<TextView
android:id="@+id/text_path"
android:layout_width="0dp"
android:layout_height="wrap_content"
android:layout_margin="@dimen/spacing_medlarge"
tools:text="/storage/emulated/0/Android/data/org.dolphinemu.dolphinemu/files"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintEnd_toEndOf="parent"
app:layout_constraintTop_toBottomOf="@id/text_type"
app:layout_constraintBottom_toTopOf="@id/text_android_11"
app:layout_constraintWidth_max="400dp" />

<TextView
android:id="@+id/text_android_11"
android:layout_width="0dp"
android:layout_height="wrap_content"
android:layout_margin="@dimen/spacing_medlarge"
android:text="@string/user_data_new_location_android_11"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintEnd_toEndOf="parent"
app:layout_constraintTop_toBottomOf="@id/text_path"
app:layout_constraintBottom_toTopOf="@id/button_open_system_file_manager"
app:layout_constraintWidth_max="400dp" />

<Button
android:id="@+id/button_open_system_file_manager"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_margin="@dimen/spacing_medlarge"
android:text="@string/user_data_open_system_file_manager"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintEnd_toEndOf="parent"
app:layout_constraintTop_toBottomOf="@id/text_android_11"
app:layout_constraintBottom_toBottomOf="parent" />

</androidx.constraintlayout.widget.ConstraintLayout>
10 changes: 9 additions & 1 deletion Source/Android/app/src/main/res/values/strings.xml
View file
Expand Up @@ -354,6 +354,14 @@
<string name="debug_jitbranchoff">Jit Branch Disabled</string>
<string name="debug_jitregistercacheoff">Jit Register Cache Disabled</string>

<!-- User Data -->
<string name="user_data_submenu">User Data</string>
<string name="user_data_old_location">Your user data is stored in a location which will <b>not</b> be deleted when you uninstall the app:</string>
<string name="user_data_new_location">Your user data is stored in a location which <b>will be deleted</b> when you uninstall the app:</string>
<string name="user_data_new_location_android_11">Because you\'re using Android 11 or newer, you can\'t access this location using file manager apps. However, you can access it using the system file manager, or by connecting your device to a PC.</string>
<string name="user_data_open_system_file_manager">Open System File Manager</string>
<string name="user_data_open_system_file_manager_failed">Sorry, Dolphin couldn\'t find the system file manager on your device.</string>

<!-- Miscellaneous -->
<string name="yes">Yes</string>
<string name="no">No</string>
Expand Down Expand Up @@ -513,7 +521,7 @@ It can efficiently compress both junk data and encrypted Wii data.
<!-- Rumble -->
<string name="rumble_not_found">Device rumble not found</string>

<string name="write_permission_needed">You need to allow write access to external storage for the emulator to work</string>
<string name="path_not_changeable_scoped_storage">Due to the Scoped Storage policy in Android 11 and newer, you can\'t change this path.</string>
<string name="load_settings">Loading Settings...</string>
<string name="setting_not_runtime_editable">This setting can\'t be changed while a game is running.</string>
<string name="setting_clear_info">Long press a setting to clear it.</string>
Expand Down
6 changes: 6 additions & 0 deletions Source/Android/app/src/main/res/xml/backup_rules.xml
View file
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<full-backup-content>
<include domain="external" path="."/>

<exclude domain="external" path="./Cache/"/>
</full-backup-content>
17 changes: 17 additions & 0 deletions Source/Android/app/src/main/res/xml/backup_rules_api_31.xml
View file
@@ -0,0 +1,17 @@
<?xml version="1.0" encoding="utf-8"?>
<data-extraction-rules>
<cloud-backup disableIfNoEncryptionCapabilities="false">
<include domain="external" path="."/>

<exclude domain="external" path="./Cache/"/>
<exclude domain="external" path="./Dump/"/>
<exclude domain="external" path="./Load/"/>
<exclude domain="external" path="./ResourcePacks/"/>
</cloud-backup>

<device-transfer>
<include domain="external" path="."/>

<exclude domain="external" path="./Cache/"/>
</device-transfer>
</data-extraction-rules>