From dd36d43ea12a6f35672dc5b8efadbe9c407fc3c4 Mon Sep 17 00:00:00 2001 From: t895 Date: Sun, 21 Jan 2024 19:07:17 -0500 Subject: [PATCH] android: Add options to verify installed content --- .../java/org/yuzu/yuzu_emu/NativeLibrary.kt | 21 +++++++++++ .../yuzu_emu/fragments/GameInfoFragment.kt | 34 +++++++++++++++++ .../fragments/HomeSettingsFragment.kt | 33 +++++++++++++++++ .../fragments/MessageDialogFragment.kt | 10 +++-- .../yuzu_emu/model/GameVerificationResult.kt | 15 ++++++++ src/android/app/src/main/jni/native.cpp | 37 +++++++++++++++++++ .../main/res/layout/fragment_game_info.xml | 8 ++++ .../app/src/main/res/values/strings.xml | 11 ++++++ 8 files changed, 165 insertions(+), 4 deletions(-) create mode 100644 src/android/app/src/main/java/org/yuzu/yuzu_emu/model/GameVerificationResult.kt diff --git a/src/android/app/src/main/java/org/yuzu/yuzu_emu/NativeLibrary.kt b/src/android/app/src/main/java/org/yuzu/yuzu_emu/NativeLibrary.kt index 1c9fb0675..c408485c6 100644 --- a/src/android/app/src/main/java/org/yuzu/yuzu_emu/NativeLibrary.kt +++ b/src/android/app/src/main/java/org/yuzu/yuzu_emu/NativeLibrary.kt @@ -23,6 +23,7 @@ import org.yuzu.yuzu_emu.utils.Log import org.yuzu.yuzu_emu.utils.SerializableHelper.serializable import org.yuzu.yuzu_emu.model.InstallResult import org.yuzu.yuzu_emu.model.Patch +import org.yuzu.yuzu_emu.model.GameVerificationResult /** * Class which contains methods that interact @@ -564,6 +565,26 @@ object NativeLibrary { */ external fun removeMod(programId: String, name: String) + /** + * Verifies all installed content + * @param callback UI callback for verification progress. Return true in the callback to cancel. + * @return Array of content that failed verification. Successful if empty. + */ + external fun verifyInstalledContents( + callback: (max: Long, progress: Long) -> Boolean + ): Array + + /** + * Verifies the contents of a game + * @param path String path to a game + * @param callback UI callback for verification progress. Return true in the callback to cancel. + * @return Int that is meant to be converted to a [GameVerificationResult] + */ + external fun verifyGameContents( + path: String, + callback: (max: Long, progress: Long) -> Boolean + ): Int + /** * Gets the save location for a specific game * diff --git a/src/android/app/src/main/java/org/yuzu/yuzu_emu/fragments/GameInfoFragment.kt b/src/android/app/src/main/java/org/yuzu/yuzu_emu/fragments/GameInfoFragment.kt index fa2a4c9f9..5aa3f453f 100644 --- a/src/android/app/src/main/java/org/yuzu/yuzu_emu/fragments/GameInfoFragment.kt +++ b/src/android/app/src/main/java/org/yuzu/yuzu_emu/fragments/GameInfoFragment.kt @@ -21,8 +21,10 @@ import androidx.fragment.app.activityViewModels import androidx.navigation.findNavController import androidx.navigation.fragment.navArgs import com.google.android.material.transition.MaterialSharedAxis +import org.yuzu.yuzu_emu.NativeLibrary import org.yuzu.yuzu_emu.R import org.yuzu.yuzu_emu.databinding.FragmentGameInfoBinding +import org.yuzu.yuzu_emu.model.GameVerificationResult import org.yuzu.yuzu_emu.model.HomeViewModel import org.yuzu.yuzu_emu.utils.GameMetadata @@ -101,6 +103,38 @@ class GameInfoFragment : Fragment() { """.trimIndent() copyToClipboard(args.game.title, details) } + + buttonVerifyIntegrity.setOnClickListener { + ProgressDialogFragment.newInstance( + requireActivity(), + R.string.verifying, + true + ) { progressCallback, _ -> + val result = GameVerificationResult.from( + NativeLibrary.verifyGameContents( + args.game.path, + progressCallback + ) + ) + return@newInstance when (result) { + GameVerificationResult.Success -> + MessageDialogFragment.newInstance( + titleId = R.string.verify_success, + descriptionId = R.string.operation_completed_successfully + ) + GameVerificationResult.Failed -> + MessageDialogFragment.newInstance( + titleId = R.string.verify_failure, + descriptionId = R.string.verify_failure_description + ) + GameVerificationResult.NotImplemented -> + MessageDialogFragment.newInstance( + titleId = R.string.verify_no_result, + descriptionId = R.string.verify_no_result_description + ) + } + }.show(parentFragmentManager, ProgressDialogFragment.TAG) + } } setInsets() diff --git a/src/android/app/src/main/java/org/yuzu/yuzu_emu/fragments/HomeSettingsFragment.kt b/src/android/app/src/main/java/org/yuzu/yuzu_emu/fragments/HomeSettingsFragment.kt index 6ddd758e6..aefae2938 100644 --- a/src/android/app/src/main/java/org/yuzu/yuzu_emu/fragments/HomeSettingsFragment.kt +++ b/src/android/app/src/main/java/org/yuzu/yuzu_emu/fragments/HomeSettingsFragment.kt @@ -32,6 +32,7 @@ import org.yuzu.yuzu_emu.BuildConfig import org.yuzu.yuzu_emu.HomeNavigationDirections import org.yuzu.yuzu_emu.NativeLibrary import org.yuzu.yuzu_emu.R +import org.yuzu.yuzu_emu.YuzuApplication import org.yuzu.yuzu_emu.adapters.HomeSettingAdapter import org.yuzu.yuzu_emu.databinding.FragmentHomeSettingsBinding import org.yuzu.yuzu_emu.features.DocumentProvider @@ -140,6 +141,38 @@ class HomeSettingsFragment : Fragment() { } ) ) + add( + HomeSetting( + R.string.verify_installed_content, + R.string.verify_installed_content_description, + R.drawable.ic_check_circle, + { + ProgressDialogFragment.newInstance( + requireActivity(), + titleId = R.string.verifying, + cancellable = true + ) { progressCallback, _ -> + val result = NativeLibrary.verifyInstalledContents(progressCallback) + return@newInstance if (result.isEmpty()) { + MessageDialogFragment.newInstance( + titleId = R.string.verify_success, + descriptionId = R.string.operation_completed_successfully + ) + } else { + val failedNames = result.joinToString("\n") + val errorMessage = YuzuApplication.appContext.getString( + R.string.verification_failed_for, + failedNames + ) + MessageDialogFragment.newInstance( + titleId = R.string.verify_failure, + descriptionString = errorMessage + ) + } + }.show(parentFragmentManager, ProgressDialogFragment.TAG) + } + ) + ) add( HomeSetting( R.string.share_log, diff --git a/src/android/app/src/main/java/org/yuzu/yuzu_emu/fragments/MessageDialogFragment.kt b/src/android/app/src/main/java/org/yuzu/yuzu_emu/fragments/MessageDialogFragment.kt index 32062b6fe..620d8db7c 100644 --- a/src/android/app/src/main/java/org/yuzu/yuzu_emu/fragments/MessageDialogFragment.kt +++ b/src/android/app/src/main/java/org/yuzu/yuzu_emu/fragments/MessageDialogFragment.kt @@ -69,7 +69,7 @@ class MessageDialogFragment : DialogFragment() { private const val HELP_LINK = "Link" fun newInstance( - activity: FragmentActivity, + activity: FragmentActivity? = null, titleId: Int = 0, titleString: String = "", descriptionId: Int = 0, @@ -86,9 +86,11 @@ class MessageDialogFragment : DialogFragment() { putString(DESCRIPTION_STRING, descriptionString) putInt(HELP_LINK, helpLinkId) } - ViewModelProvider(activity)[MessageDialogViewModel::class.java].apply { - clear() - this.positiveAction = positiveAction + if (activity != null) { + ViewModelProvider(activity)[MessageDialogViewModel::class.java].apply { + clear() + this.positiveAction = positiveAction + } } dialog.arguments = bundle return dialog diff --git a/src/android/app/src/main/java/org/yuzu/yuzu_emu/model/GameVerificationResult.kt b/src/android/app/src/main/java/org/yuzu/yuzu_emu/model/GameVerificationResult.kt new file mode 100644 index 000000000..804637fb8 --- /dev/null +++ b/src/android/app/src/main/java/org/yuzu/yuzu_emu/model/GameVerificationResult.kt @@ -0,0 +1,15 @@ +// SPDX-FileCopyrightText: 2024 yuzu Emulator Project +// SPDX-License-Identifier: GPL-2.0-or-later + +package org.yuzu.yuzu_emu.model + +enum class GameVerificationResult(val int: Int) { + Success(0), + Failed(1), + NotImplemented(2); + + companion object { + fun from(int: Int): GameVerificationResult = + entries.firstOrNull { it.int == int } ?: Success + } +} diff --git a/src/android/app/src/main/jni/native.cpp b/src/android/app/src/main/jni/native.cpp index be0a723b1..963f57380 100644 --- a/src/android/app/src/main/jni/native.cpp +++ b/src/android/app/src/main/jni/native.cpp @@ -829,6 +829,43 @@ void Java_org_yuzu_yuzu_1emu_NativeLibrary_removeMod(JNIEnv* env, jobject jobj, program_id, GetJString(env, jname)); } +jobject Java_org_yuzu_yuzu_1emu_NativeLibrary_verifyInstalledContents(JNIEnv* env, jobject jobj, + jobject jcallback) { + auto jlambdaClass = env->GetObjectClass(jcallback); + auto jlambdaInvokeMethod = env->GetMethodID( + jlambdaClass, "invoke", "(Ljava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object;"); + const auto callback = [env, jcallback, jlambdaInvokeMethod](size_t max, size_t progress) { + auto jwasCancelled = env->CallObjectMethod(jcallback, jlambdaInvokeMethod, + ToJDouble(env, max), ToJDouble(env, progress)); + return GetJBoolean(env, jwasCancelled); + }; + + auto& session = EmulationSession::GetInstance(); + std::vector result = ContentManager::VerifyInstalledContents( + &session.System(), session.GetContentProvider(), callback); + jobjectArray jresult = + env->NewObjectArray(result.size(), IDCache::GetStringClass(), ToJString(env, "")); + for (size_t i = 0; i < result.size(); ++i) { + env->SetObjectArrayElement(jresult, i, ToJString(env, result[i])); + } + return jresult; +} + +jint Java_org_yuzu_yuzu_1emu_NativeLibrary_verifyGameContents(JNIEnv* env, jobject jobj, + jstring jpath, jobject jcallback) { + auto jlambdaClass = env->GetObjectClass(jcallback); + auto jlambdaInvokeMethod = env->GetMethodID( + jlambdaClass, "invoke", "(Ljava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object;"); + const auto callback = [env, jcallback, jlambdaInvokeMethod](size_t max, size_t progress) { + auto jwasCancelled = env->CallObjectMethod(jcallback, jlambdaInvokeMethod, + ToJDouble(env, max), ToJDouble(env, progress)); + return GetJBoolean(env, jwasCancelled); + }; + auto& session = EmulationSession::GetInstance(); + return static_cast( + ContentManager::VerifyGameContents(&session.System(), GetJString(env, jpath), callback)); +} + jstring Java_org_yuzu_yuzu_1emu_NativeLibrary_getSavePath(JNIEnv* env, jobject jobj, jstring jprogramId) { auto program_id = EmulationSession::GetProgramId(env, jprogramId); diff --git a/src/android/app/src/main/res/layout/fragment_game_info.xml b/src/android/app/src/main/res/layout/fragment_game_info.xml index 80ede8a8c..53af15787 100644 --- a/src/android/app/src/main/res/layout/fragment_game_info.xml +++ b/src/android/app/src/main/res/layout/fragment_game_info.xml @@ -118,6 +118,14 @@ android:layout_marginTop="16dp" android:text="@string/copy_details" /> + + diff --git a/src/android/app/src/main/res/values/strings.xml b/src/android/app/src/main/res/values/strings.xml index bfcbb5812..eefcc3ff4 100644 --- a/src/android/app/src/main/res/values/strings.xml +++ b/src/android/app/src/main/res/values/strings.xml @@ -142,6 +142,8 @@ Successfully imported %d saves No save data found + Verify installed content + Checks all installed content for corruption Applet launcher @@ -288,6 +290,7 @@ Import complete More options Use global setting + The operation completed successfully Select GPU driver @@ -352,6 +355,14 @@ The content that you selected does not match this game.\nInstall anyway? Confirm uninstall Are you sure you want to uninstall this addon? + Verify integrity + Verifying… + Integrity verification succeeded! + Integrity verification failed! + File contents may be corrupt + Integrity verification couldn\'t be performed + File contents were not checked for validity + Verification failed for the following files:\n%1$s Your ROM is encrypted