From c725f3c86cba71f513c9af352f65c4dffb5f187a Mon Sep 17 00:00:00 2001 From: t895 Date: Sun, 21 Jan 2024 16:36:37 -0500 Subject: frontend_common: Move integrity verification to content_manager --- src/frontend_common/content_manager.h | 137 ++++++++++++++++++++++++++++++++- src/yuzu/main.cpp | 138 +++++++--------------------------- 2 files changed, 161 insertions(+), 114 deletions(-) diff --git a/src/frontend_common/content_manager.h b/src/frontend_common/content_manager.h index 23f2979db..92276700b 100644 --- a/src/frontend_common/content_manager.h +++ b/src/frontend_common/content_manager.h @@ -11,10 +11,12 @@ #include "core/file_sys/content_archive.h" #include "core/file_sys/mode.h" #include "core/file_sys/nca_metadata.h" +#include "core/file_sys/patch_manager.h" #include "core/file_sys/registered_cache.h" #include "core/file_sys/submission_package.h" #include "core/hle/service/filesystem/filesystem.h" #include "core/loader/loader.h" +#include "core/loader/nca.h" namespace ContentManager { @@ -25,6 +27,12 @@ enum class InstallResult { BaseInstallAttempted, }; +enum class GameVerificationResult { + Success, + Failed, + NotImplemented, +}; + /** * \brief Removes a single installed DLC * \param fs_controller [FileSystemController] reference from the Core::System instance @@ -121,7 +129,7 @@ inline bool RemoveMod(const Service::FileSystem::FileSystemController& fs_contro * \param filename Path to the NSP file * \param callback Optional callback to report the progress of the installation. The first size_t * parameter is the total size of the virtual file and the second is the current progress. If you - * return false to the callback, it will cancel the installation as soon as possible. + * return true to the callback, it will cancel the installation as soon as possible. * \return [InstallResult] representing how the installation finished */ inline InstallResult InstallNSP( @@ -186,7 +194,7 @@ inline InstallResult InstallNSP( * \param title_type Type of NCA package to install * \param callback Optional callback to report the progress of the installation. The first size_t * parameter is the total size of the virtual file and the second is the current progress. If you - * return false to the callback, it will cancel the installation as soon as possible. + * return true to the callback, it will cancel the installation as soon as possible. * \return [InstallResult] representing how the installation finished */ inline InstallResult InstallNCA( @@ -235,4 +243,129 @@ inline InstallResult InstallNCA( } } +/** + * \brief Verifies the installed contents for a given ManualContentProvider + * \param system Raw pointer to the system instance + * \param provider Raw pointer to the content provider that's tracking indexed games + * \param callback Optional callback to report the progress of the installation. The first size_t + * parameter is the total size of the installed contents and the second is the current progress. If + * you return true to the callback, it will cancel the installation as soon as possible. + * \return A list of entries that failed to install. Returns an empty vector if successful. + */ +inline std::vector VerifyInstalledContents( + Core::System* system, FileSys::ManualContentProvider* provider, + const std::function& callback = std::function()) { + // Get content registries. + auto bis_contents = system->GetFileSystemController().GetSystemNANDContents(); + auto user_contents = system->GetFileSystemController().GetUserNANDContents(); + + std::vector content_providers; + if (bis_contents) { + content_providers.push_back(bis_contents); + } + if (user_contents) { + content_providers.push_back(user_contents); + } + + // Get associated NCA files. + std::vector nca_files; + + // Get all installed IDs. + size_t total_size = 0; + for (auto nca_provider : content_providers) { + const auto entries = nca_provider->ListEntriesFilter(); + + for (const auto& entry : entries) { + auto nca_file = nca_provider->GetEntryRaw(entry.title_id, entry.type); + if (!nca_file) { + continue; + } + + total_size += nca_file->GetSize(); + nca_files.push_back(std::move(nca_file)); + } + } + + // Declare a list of file names which failed to verify. + std::vector failed; + + size_t processed_size = 0; + bool cancelled = false; + auto nca_callback = [&](size_t nca_processed, size_t nca_total) { + cancelled = callback(total_size, processed_size + nca_processed); + return !cancelled; + }; + + // Using the NCA loader, determine if all NCAs are valid. + for (auto& nca_file : nca_files) { + Loader::AppLoader_NCA nca_loader(nca_file); + + auto status = nca_loader.VerifyIntegrity(nca_callback); + if (cancelled) { + break; + } + if (status != Loader::ResultStatus::Success) { + FileSys::NCA nca(nca_file); + const auto title_id = nca.GetTitleId(); + std::string title_name = "unknown"; + + const auto control = provider->GetEntry(FileSys::GetBaseTitleID(title_id), + FileSys::ContentRecordType::Control); + if (control && control->GetStatus() == Loader::ResultStatus::Success) { + const FileSys::PatchManager pm{title_id, system->GetFileSystemController(), + *provider}; + const auto [nacp, logo] = pm.ParseControlNCA(*control); + if (nacp) { + title_name = nacp->GetApplicationName(); + } + } + + if (title_id > 0) { + failed.push_back( + fmt::format("{} ({:016X}) ({})", nca_file->GetName(), title_id, title_name)); + } else { + failed.push_back(fmt::format("{} (unknown)", nca_file->GetName())); + } + } + + processed_size += nca_file->GetSize(); + } + return failed; +} + +/** + * \brief Verifies the contents of a given game + * \param system Raw pointer to the system instance + * \param game_path Patch to the game file + * \param callback Optional callback to report the progress of the installation. The first size_t + * parameter is the total size of the installed contents and the second is the current progress. If + * you return true to the callback, it will cancel the installation as soon as possible. + * \return GameVerificationResult representing how the verification process finished + */ +inline GameVerificationResult VerifyGameContents( + Core::System* system, const std::string& game_path, + const std::function& callback = std::function()) { + const auto loader = Loader::GetLoader( + *system, system->GetFilesystem()->OpenFile(game_path, FileSys::Mode::Read)); + if (loader == nullptr) { + return GameVerificationResult::NotImplemented; + } + + bool cancelled = false; + auto loader_callback = [&](size_t processed, size_t total) { + cancelled = callback(total, processed); + return !cancelled; + }; + + const auto status = loader->VerifyIntegrity(loader_callback); + if (cancelled || status == Loader::ResultStatus::ErrorIntegrityVerificationNotImplemented) { + return GameVerificationResult::NotImplemented; + } + + if (status == Loader::ResultStatus::ErrorIntegrityVerificationFailed) { + return GameVerificationResult::Failed; + } + return GameVerificationResult::Success; +} + } // namespace ContentManager diff --git a/src/yuzu/main.cpp b/src/yuzu/main.cpp index 05bd4174c..d8b0beadf 100644 --- a/src/yuzu/main.cpp +++ b/src/yuzu/main.cpp @@ -2786,16 +2786,6 @@ void GMainWindow::OnGameListVerifyIntegrity(const std::string& game_path) { QMessageBox::warning(this, tr("Integrity verification couldn't be performed!"), tr("File contents were not checked for validity.")); }; - const auto Failed = [this] { - QMessageBox::critical(this, tr("Integrity verification failed!"), - tr("File contents may be corrupt.")); - }; - - const auto loader = Loader::GetLoader(*system, vfs->OpenFile(game_path, FileSys::Mode::Read)); - if (loader == nullptr) { - NotImplemented(); - return; - } QProgressDialog progress(tr("Verifying integrity..."), tr("Cancel"), 0, 100, this); progress.setWindowModality(Qt::WindowModal); @@ -2803,30 +2793,26 @@ void GMainWindow::OnGameListVerifyIntegrity(const std::string& game_path) { progress.setAutoClose(false); progress.setAutoReset(false); - const auto QtProgressCallback = [&](size_t processed_size, size_t total_size) { - if (progress.wasCanceled()) { - return false; - } - + const auto QtProgressCallback = [&](size_t total_size, size_t processed_size) { progress.setValue(static_cast((processed_size * 100) / total_size)); - return true; + return progress.wasCanceled(); }; - const auto status = loader->VerifyIntegrity(QtProgressCallback); - if (progress.wasCanceled() || - status == Loader::ResultStatus::ErrorIntegrityVerificationNotImplemented) { + const auto result = + ContentManager::VerifyGameContents(system.get(), game_path, QtProgressCallback); + progress.close(); + switch (result) { + case ContentManager::GameVerificationResult::Success: + QMessageBox::information(this, tr("Integrity verification succeeded!"), + tr("The operation completed successfully.")); + break; + case ContentManager::GameVerificationResult::Failed: + QMessageBox::critical(this, tr("Integrity verification failed!"), + tr("File contents may be corrupt.")); + break; + case ContentManager::GameVerificationResult::NotImplemented: NotImplemented(); - return; - } - - if (status == Loader::ResultStatus::ErrorIntegrityVerificationFailed) { - Failed(); - return; } - - progress.close(); - QMessageBox::information(this, tr("Integrity verification succeeded!"), - tr("The operation completed successfully.")); } void GMainWindow::OnGameListCopyTID(u64 program_id) { @@ -4121,10 +4107,6 @@ void GMainWindow::OnOpenYuzuFolder() { } void GMainWindow::OnVerifyInstalledContents() { - // Declare sizes. - size_t total_size = 0; - size_t processed_size = 0; - // Initialize a progress dialog. QProgressDialog progress(tr("Verifying integrity..."), tr("Cancel"), 0, 100, this); progress.setWindowModality(Qt::WindowModal); @@ -4132,93 +4114,25 @@ void GMainWindow::OnVerifyInstalledContents() { progress.setAutoClose(false); progress.setAutoReset(false); - // Declare a list of file names which failed to verify. - std::vector failed; - // Declare progress callback. - auto QtProgressCallback = [&](size_t nca_processed, size_t nca_total) { - if (progress.wasCanceled()) { - return false; - } - progress.setValue(static_cast(((processed_size + nca_processed) * 100) / total_size)); - return true; + auto QtProgressCallback = [&](size_t total_size, size_t processed_size) { + progress.setValue(static_cast((processed_size * 100) / total_size)); + return progress.wasCanceled(); }; - // Get content registries. - auto bis_contents = system->GetFileSystemController().GetSystemNANDContents(); - auto user_contents = system->GetFileSystemController().GetUserNANDContents(); - - std::vector content_providers; - if (bis_contents) { - content_providers.push_back(bis_contents); - } - if (user_contents) { - content_providers.push_back(user_contents); - } - - // Get associated NCA files. - std::vector nca_files; - - // Get all installed IDs. - for (auto nca_provider : content_providers) { - const auto entries = nca_provider->ListEntriesFilter(); - - for (const auto& entry : entries) { - auto nca_file = nca_provider->GetEntryRaw(entry.title_id, entry.type); - if (!nca_file) { - continue; - } - - total_size += nca_file->GetSize(); - nca_files.push_back(std::move(nca_file)); - } - } - - // Using the NCA loader, determine if all NCAs are valid. - for (auto& nca_file : nca_files) { - Loader::AppLoader_NCA nca_loader(nca_file); - - auto status = nca_loader.VerifyIntegrity(QtProgressCallback); - if (progress.wasCanceled()) { - break; - } - if (status != Loader::ResultStatus::Success) { - FileSys::NCA nca(nca_file); - const auto title_id = nca.GetTitleId(); - std::string title_name = "unknown"; - - const auto control = provider->GetEntry(FileSys::GetBaseTitleID(title_id), - FileSys::ContentRecordType::Control); - if (control && control->GetStatus() == Loader::ResultStatus::Success) { - const FileSys::PatchManager pm{title_id, system->GetFileSystemController(), - *provider}; - const auto [nacp, logo] = pm.ParseControlNCA(*control); - if (nacp) { - title_name = nacp->GetApplicationName(); - } - } - - if (title_id > 0) { - failed.push_back( - fmt::format("{} ({:016X}) ({})", nca_file->GetName(), title_id, title_name)); - } else { - failed.push_back(fmt::format("{} (unknown)", nca_file->GetName())); - } - } - - processed_size += nca_file->GetSize(); - } - + const std::vector result = + ContentManager::VerifyInstalledContents(system.get(), provider.get(), QtProgressCallback); progress.close(); - if (failed.size() > 0) { - auto failed_names = QString::fromStdString(fmt::format("{}", fmt::join(failed, "\n"))); + if (result.empty()) { + QMessageBox::information(this, tr("Integrity verification succeeded!"), + tr("The operation completed successfully.")); + } else { + const auto failed_names = + QString::fromStdString(fmt::format("{}", fmt::join(result, "\n"))); QMessageBox::critical( this, tr("Integrity verification failed!"), tr("Verification failed for the following files:\n\n%1").arg(failed_names)); - } else { - QMessageBox::information(this, tr("Integrity verification succeeded!"), - tr("The operation completed successfully.")); } } -- cgit v1.2.3