2022-04-23 10:59:50 +02:00
|
|
|
// SPDX-FileCopyrightText: Copyright 2018 yuzu Emulator Project
|
|
|
|
// SPDX-License-Identifier: GPL-2.0-or-later
|
2018-08-26 01:03:45 +02:00
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
|
|
|
#include <map>
|
2018-09-06 19:51:57 +02:00
|
|
|
#include <memory>
|
2020-09-03 09:51:49 +02:00
|
|
|
#include <optional>
|
2018-08-26 16:53:31 +02:00
|
|
|
#include <string>
|
2018-08-26 01:03:45 +02:00
|
|
|
#include "common/common_types.h"
|
2018-09-04 00:57:52 +02:00
|
|
|
#include "core/file_sys/nca_metadata.h"
|
2020-08-23 20:20:37 +02:00
|
|
|
#include "core/file_sys/vfs_types.h"
|
2019-05-31 01:35:52 +02:00
|
|
|
#include "core/memory/dmnt_cheat_types.h"
|
2018-08-26 01:03:45 +02:00
|
|
|
|
2019-03-22 11:08:11 +01:00
|
|
|
namespace Core {
|
|
|
|
class System;
|
|
|
|
}
|
|
|
|
|
2020-11-18 13:53:10 +01:00
|
|
|
namespace Service::FileSystem {
|
|
|
|
class FileSystemController;
|
|
|
|
}
|
|
|
|
|
2018-08-26 01:03:45 +02:00
|
|
|
namespace FileSys {
|
|
|
|
|
2020-11-18 13:53:10 +01:00
|
|
|
class ContentProvider;
|
2018-08-29 04:38:35 +02:00
|
|
|
class NCA;
|
2018-09-04 00:57:52 +02:00
|
|
|
class NACP;
|
2018-08-29 04:38:35 +02:00
|
|
|
|
2024-01-19 22:37:34 +01:00
|
|
|
enum class PatchType { Update, DLC, Mod };
|
|
|
|
|
|
|
|
struct Patch {
|
|
|
|
bool enabled;
|
|
|
|
std::string name;
|
|
|
|
std::string version;
|
|
|
|
PatchType type;
|
|
|
|
u64 program_id;
|
|
|
|
u64 title_id;
|
|
|
|
};
|
|
|
|
|
2018-08-26 01:03:45 +02:00
|
|
|
// A centralized class to manage patches to games.
|
|
|
|
class PatchManager {
|
|
|
|
public:
|
2020-09-15 01:09:49 +02:00
|
|
|
using BuildID = std::array<u8, 0x20>;
|
|
|
|
using Metadata = std::pair<std::unique_ptr<NACP>, VirtualFile>;
|
|
|
|
|
2020-11-18 13:53:10 +01:00
|
|
|
explicit PatchManager(u64 title_id_,
|
|
|
|
const Service::FileSystem::FileSystemController& fs_controller_,
|
|
|
|
const ContentProvider& content_provider_);
|
2018-09-20 01:19:05 +02:00
|
|
|
~PatchManager();
|
2018-08-26 01:03:45 +02:00
|
|
|
|
2020-09-15 01:09:49 +02:00
|
|
|
[[nodiscard]] u64 GetTitleID() const;
|
2018-11-28 20:01:09 +01:00
|
|
|
|
2018-08-26 01:03:45 +02:00
|
|
|
// Currently tracked ExeFS patches:
|
|
|
|
// - Game Updates
|
2020-09-15 01:09:49 +02:00
|
|
|
[[nodiscard]] VirtualDir PatchExeFS(VirtualDir exefs) const;
|
2018-08-26 01:03:45 +02:00
|
|
|
|
2018-09-30 04:15:16 +02:00
|
|
|
// Currently tracked NSO patches:
|
|
|
|
// - IPS
|
2018-10-01 14:31:34 +02:00
|
|
|
// - IPSwitch
|
2020-09-15 01:09:49 +02:00
|
|
|
[[nodiscard]] std::vector<u8> PatchNSO(const std::vector<u8>& nso,
|
|
|
|
const std::string& name) const;
|
2018-09-30 04:15:16 +02:00
|
|
|
|
|
|
|
// Checks to see if PatchNSO() will have any effect given the NSO's build ID.
|
|
|
|
// Used to prevent expensive copies in NSO loader.
|
2023-09-14 20:34:05 +02:00
|
|
|
[[nodiscard]] bool HasNSOPatch(const BuildID& build_id, std::string_view name) const;
|
2018-09-30 04:15:16 +02:00
|
|
|
|
2018-12-23 03:28:56 +01:00
|
|
|
// Creates a CheatList object with all
|
2020-09-15 01:09:49 +02:00
|
|
|
[[nodiscard]] std::vector<Core::Memory::CheatEntry> CreateCheatList(
|
2020-11-18 13:53:10 +01:00
|
|
|
const BuildID& build_id) const;
|
2018-12-23 03:28:56 +01:00
|
|
|
|
2018-08-26 01:03:45 +02:00
|
|
|
// Currently tracked RomFS patches:
|
|
|
|
// - Game Updates
|
2018-09-20 04:02:44 +02:00
|
|
|
// - LayeredFS
|
2023-08-11 03:34:43 +02:00
|
|
|
[[nodiscard]] VirtualFile PatchRomFS(const NCA* base_nca, VirtualFile base_romfs,
|
2020-09-15 01:09:49 +02:00
|
|
|
ContentRecordType type = ContentRecordType::Program,
|
2023-08-11 03:34:43 +02:00
|
|
|
VirtualFile packed_update_raw = nullptr,
|
2021-06-28 16:07:40 +02:00
|
|
|
bool apply_layeredfs = true) const;
|
2018-08-26 01:03:45 +02:00
|
|
|
|
2024-01-19 22:37:34 +01:00
|
|
|
// Returns a vector of patches
|
|
|
|
[[nodiscard]] std::vector<Patch> GetPatches(VirtualFile update_raw = nullptr) const;
|
2018-08-26 01:03:45 +02:00
|
|
|
|
2019-06-26 04:25:10 +02:00
|
|
|
// If the game update exists, returns the u32 version field in its Meta-type NCA. If that fails,
|
|
|
|
// it will fallback to the Meta-type NCA of the base game. If that fails, the result will be
|
|
|
|
// std::nullopt
|
2020-09-15 01:09:49 +02:00
|
|
|
[[nodiscard]] std::optional<u32> GetGameVersion() const;
|
2019-06-25 01:05:50 +02:00
|
|
|
|
|
|
|
// Given title_id of the program, attempts to get the control data of the update and parse
|
|
|
|
// it, falling back to the base control data.
|
2020-09-15 01:09:49 +02:00
|
|
|
[[nodiscard]] Metadata GetControlMetadata() const;
|
2018-09-04 00:57:52 +02:00
|
|
|
|
|
|
|
// Version of GetControlMetadata that takes an arbitrary NCA
|
2020-09-15 01:09:49 +02:00
|
|
|
[[nodiscard]] Metadata ParseControlNCA(const NCA& nca) const;
|
2018-09-04 00:57:52 +02:00
|
|
|
|
2018-08-26 01:03:45 +02:00
|
|
|
private:
|
2020-09-15 01:09:49 +02:00
|
|
|
[[nodiscard]] std::vector<VirtualFile> CollectPatches(const std::vector<VirtualDir>& patch_dirs,
|
|
|
|
const std::string& build_id) const;
|
2018-11-28 20:01:09 +01:00
|
|
|
|
2018-08-26 01:03:45 +02:00
|
|
|
u64 title_id;
|
2020-11-18 13:53:10 +01:00
|
|
|
const Service::FileSystem::FileSystemController& fs_controller;
|
|
|
|
const ContentProvider& content_provider;
|
2018-08-26 01:03:45 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
} // namespace FileSys
|