FileSys: abstract SD save data archive source
This commit is contained in:
parent
3174bfd50c
commit
5af117e00c
|
@ -22,6 +22,7 @@ set(SRCS
|
|||
file_sys/archive_savedata.cpp
|
||||
file_sys/archive_sdmc.cpp
|
||||
file_sys/archive_sdmcwriteonly.cpp
|
||||
file_sys/archive_source_sd_savedata.cpp
|
||||
file_sys/archive_systemsavedata.cpp
|
||||
file_sys/disk_archive.cpp
|
||||
file_sys/ivfc_archive.cpp
|
||||
|
@ -167,6 +168,7 @@ set(HEADERS
|
|||
file_sys/archive_savedata.h
|
||||
file_sys/archive_sdmc.h
|
||||
file_sys/archive_sdmcwriteonly.h
|
||||
file_sys/archive_source_sd_savedata.h
|
||||
file_sys/archive_systemsavedata.h
|
||||
file_sys/directory_backend.h
|
||||
file_sys/disk_archive.h
|
||||
|
|
|
@ -2,96 +2,29 @@
|
|||
// Licensed under GPLv2 or any later version
|
||||
// Refer to the license.txt file included.
|
||||
|
||||
#include <algorithm>
|
||||
#include <memory>
|
||||
#include "common/common_types.h"
|
||||
#include "common/file_util.h"
|
||||
#include "common/logging/log.h"
|
||||
#include "common/string_util.h"
|
||||
#include "core/file_sys/archive_savedata.h"
|
||||
#include "core/file_sys/savedata_archive.h"
|
||||
#include "core/hle/kernel/process.h"
|
||||
#include "core/hle/service/fs/archive.h"
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
// FileSys namespace
|
||||
|
||||
namespace FileSys {
|
||||
|
||||
static std::string GetSaveDataContainerPath(const std::string& sdmc_directory) {
|
||||
return Common::StringFromFormat("%sNintendo 3DS/%s/%s/title/", sdmc_directory.c_str(),
|
||||
SYSTEM_ID.c_str(), SDCARD_ID.c_str());
|
||||
}
|
||||
|
||||
static std::string GetSaveDataPath(const std::string& mount_location, u64 program_id) {
|
||||
u32 high = (u32)(program_id >> 32);
|
||||
u32 low = (u32)(program_id & 0xFFFFFFFF);
|
||||
return Common::StringFromFormat("%s%08x/%08x/data/00000001/", mount_location.c_str(), high,
|
||||
low);
|
||||
}
|
||||
|
||||
static std::string GetSaveDataMetadataPath(const std::string& mount_location, u64 program_id) {
|
||||
u32 high = (u32)(program_id >> 32);
|
||||
u32 low = (u32)(program_id & 0xFFFFFFFF);
|
||||
return Common::StringFromFormat("%s%08x/%08x/data/00000001.metadata", mount_location.c_str(),
|
||||
high, low);
|
||||
}
|
||||
|
||||
ArchiveFactory_SaveData::ArchiveFactory_SaveData(const std::string& sdmc_directory)
|
||||
: mount_point(GetSaveDataContainerPath(sdmc_directory)) {
|
||||
LOG_INFO(Service_FS, "Directory %s set as SaveData.", this->mount_point.c_str());
|
||||
}
|
||||
ArchiveFactory_SaveData::ArchiveFactory_SaveData(
|
||||
std::shared_ptr<ArchiveSource_SDSaveData> sd_savedata)
|
||||
: sd_savedata_source(sd_savedata) {}
|
||||
|
||||
ResultVal<std::unique_ptr<ArchiveBackend>> ArchiveFactory_SaveData::Open(const Path& path) {
|
||||
std::string concrete_mount_point =
|
||||
GetSaveDataPath(mount_point, Kernel::g_current_process->codeset->program_id);
|
||||
if (!FileUtil::Exists(concrete_mount_point)) {
|
||||
// When a SaveData archive is created for the first time, it is not yet formatted and the
|
||||
// save file/directory structure expected by the game has not yet been initialized.
|
||||
// Returning the NotFormatted error code will signal the game to provision the SaveData
|
||||
// archive with the files and folders that it expects.
|
||||
return ResultCode(ErrorDescription::FS_NotFormatted, ErrorModule::FS,
|
||||
ErrorSummary::InvalidState, ErrorLevel::Status);
|
||||
}
|
||||
|
||||
auto archive = std::make_unique<SaveDataArchive>(std::move(concrete_mount_point));
|
||||
return MakeResult<std::unique_ptr<ArchiveBackend>>(std::move(archive));
|
||||
return sd_savedata_source->Open(Kernel::g_current_process->codeset->program_id);
|
||||
}
|
||||
|
||||
ResultCode ArchiveFactory_SaveData::Format(const Path& path,
|
||||
const FileSys::ArchiveFormatInfo& format_info) {
|
||||
std::string concrete_mount_point =
|
||||
GetSaveDataPath(mount_point, Kernel::g_current_process->codeset->program_id);
|
||||
FileUtil::DeleteDirRecursively(concrete_mount_point);
|
||||
FileUtil::CreateFullPath(concrete_mount_point);
|
||||
|
||||
// Write the format metadata
|
||||
std::string metadata_path =
|
||||
GetSaveDataMetadataPath(mount_point, Kernel::g_current_process->codeset->program_id);
|
||||
FileUtil::IOFile file(metadata_path, "wb");
|
||||
|
||||
if (file.IsOpen()) {
|
||||
file.WriteBytes(&format_info, sizeof(format_info));
|
||||
return RESULT_SUCCESS;
|
||||
}
|
||||
return RESULT_SUCCESS;
|
||||
return sd_savedata_source->Format(Kernel::g_current_process->codeset->program_id, format_info);
|
||||
}
|
||||
|
||||
ResultVal<ArchiveFormatInfo> ArchiveFactory_SaveData::GetFormatInfo(const Path& path) const {
|
||||
std::string metadata_path =
|
||||
GetSaveDataMetadataPath(mount_point, Kernel::g_current_process->codeset->program_id);
|
||||
FileUtil::IOFile file(metadata_path, "rb");
|
||||
|
||||
if (!file.IsOpen()) {
|
||||
LOG_ERROR(Service_FS, "Could not open metadata information for archive");
|
||||
// TODO(Subv): Verify error code
|
||||
return ResultCode(ErrorDescription::FS_NotFormatted, ErrorModule::FS,
|
||||
ErrorSummary::InvalidState, ErrorLevel::Status);
|
||||
}
|
||||
|
||||
ArchiveFormatInfo info = {};
|
||||
file.ReadBytes(&info, sizeof(info));
|
||||
return MakeResult<ArchiveFormatInfo>(info);
|
||||
return sd_savedata_source->GetFormatInfo(Kernel::g_current_process->codeset->program_id);
|
||||
}
|
||||
|
||||
} // namespace FileSys
|
||||
|
|
|
@ -4,10 +4,7 @@
|
|||
|
||||
#pragma once
|
||||
|
||||
#include <memory>
|
||||
#include <string>
|
||||
#include "core/file_sys/archive_backend.h"
|
||||
#include "core/hle/result.h"
|
||||
#include "core/file_sys/archive_source_sd_savedata.h"
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
// FileSys namespace
|
||||
|
@ -17,7 +14,7 @@ namespace FileSys {
|
|||
/// File system interface to the SaveData archive
|
||||
class ArchiveFactory_SaveData final : public ArchiveFactory {
|
||||
public:
|
||||
ArchiveFactory_SaveData(const std::string& mount_point);
|
||||
explicit ArchiveFactory_SaveData(std::shared_ptr<ArchiveSource_SDSaveData> sd_savedata_source);
|
||||
|
||||
std::string GetName() const override {
|
||||
return "SaveData";
|
||||
|
@ -30,6 +27,7 @@ public:
|
|||
|
||||
private:
|
||||
std::string mount_point;
|
||||
std::shared_ptr<ArchiveSource_SDSaveData> sd_savedata_source;
|
||||
};
|
||||
|
||||
} // namespace FileSys
|
||||
|
|
|
@ -0,0 +1,93 @@
|
|||
// Copyright 2016 Citra Emulator Project
|
||||
// Licensed under GPLv2 or any later version
|
||||
// Refer to the license.txt file included.
|
||||
|
||||
#include "common/file_util.h"
|
||||
#include "common/logging/log.h"
|
||||
#include "common/string_util.h"
|
||||
#include "core/file_sys/archive_source_sd_savedata.h"
|
||||
#include "core/file_sys/savedata_archive.h"
|
||||
#include "core/hle/service/fs/archive.h"
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
// FileSys namespace
|
||||
|
||||
namespace FileSys {
|
||||
|
||||
namespace {
|
||||
|
||||
std::string GetSaveDataContainerPath(const std::string& sdmc_directory) {
|
||||
return Common::StringFromFormat("%sNintendo 3DS/%s/%s/title/", sdmc_directory.c_str(),
|
||||
SYSTEM_ID.c_str(), SDCARD_ID.c_str());
|
||||
}
|
||||
|
||||
std::string GetSaveDataPath(const std::string& mount_location, u64 program_id) {
|
||||
u32 high = static_cast<u32>(program_id >> 32);
|
||||
u32 low = static_cast<u32>(program_id & 0xFFFFFFFF);
|
||||
return Common::StringFromFormat("%s%08x/%08x/data/00000001/", mount_location.c_str(), high,
|
||||
low);
|
||||
}
|
||||
|
||||
std::string GetSaveDataMetadataPath(const std::string& mount_location, u64 program_id) {
|
||||
u32 high = static_cast<u32>(program_id >> 32);
|
||||
u32 low = static_cast<u32>(program_id & 0xFFFFFFFF);
|
||||
return Common::StringFromFormat("%s%08x/%08x/data/00000001.metadata", mount_location.c_str(),
|
||||
high, low);
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
ArchiveSource_SDSaveData::ArchiveSource_SDSaveData(const std::string& sdmc_directory)
|
||||
: mount_point(GetSaveDataContainerPath(sdmc_directory)) {
|
||||
LOG_INFO(Service_FS, "Directory %s set as SaveData.", mount_point.c_str());
|
||||
}
|
||||
|
||||
ResultVal<std::unique_ptr<ArchiveBackend>> ArchiveSource_SDSaveData::Open(u64 program_id) {
|
||||
std::string concrete_mount_point = GetSaveDataPath(mount_point, program_id);
|
||||
if (!FileUtil::Exists(concrete_mount_point)) {
|
||||
// When a SaveData archive is created for the first time, it is not yet formatted and the
|
||||
// save file/directory structure expected by the game has not yet been initialized.
|
||||
// Returning the NotFormatted error code will signal the game to provision the SaveData
|
||||
// archive with the files and folders that it expects.
|
||||
return ResultCode(ErrorDescription::FS_NotFormatted, ErrorModule::FS,
|
||||
ErrorSummary::InvalidState, ErrorLevel::Status);
|
||||
}
|
||||
|
||||
auto archive = std::make_unique<SaveDataArchive>(std::move(concrete_mount_point));
|
||||
return MakeResult<std::unique_ptr<ArchiveBackend>>(std::move(archive));
|
||||
}
|
||||
|
||||
ResultCode ArchiveSource_SDSaveData::Format(u64 program_id,
|
||||
const FileSys::ArchiveFormatInfo& format_info) {
|
||||
std::string concrete_mount_point = GetSaveDataPath(mount_point, program_id);
|
||||
FileUtil::DeleteDirRecursively(concrete_mount_point);
|
||||
FileUtil::CreateFullPath(concrete_mount_point);
|
||||
|
||||
// Write the format metadata
|
||||
std::string metadata_path = GetSaveDataMetadataPath(mount_point, program_id);
|
||||
FileUtil::IOFile file(metadata_path, "wb");
|
||||
|
||||
if (file.IsOpen()) {
|
||||
file.WriteBytes(&format_info, sizeof(format_info));
|
||||
return RESULT_SUCCESS;
|
||||
}
|
||||
return RESULT_SUCCESS;
|
||||
}
|
||||
|
||||
ResultVal<ArchiveFormatInfo> ArchiveSource_SDSaveData::GetFormatInfo(u64 program_id) const {
|
||||
std::string metadata_path = GetSaveDataMetadataPath(mount_point, program_id);
|
||||
FileUtil::IOFile file(metadata_path, "rb");
|
||||
|
||||
if (!file.IsOpen()) {
|
||||
LOG_ERROR(Service_FS, "Could not open metadata information for archive");
|
||||
// TODO(Subv): Verify error code
|
||||
return ResultCode(ErrorDescription::FS_NotFormatted, ErrorModule::FS,
|
||||
ErrorSummary::InvalidState, ErrorLevel::Status);
|
||||
}
|
||||
|
||||
ArchiveFormatInfo info = {};
|
||||
file.ReadBytes(&info, sizeof(info));
|
||||
return MakeResult<ArchiveFormatInfo>(info);
|
||||
}
|
||||
|
||||
} // namespace FileSys
|
|
@ -0,0 +1,30 @@
|
|||
// Copyright 2016 Citra Emulator Project
|
||||
// Licensed under GPLv2 or any later version
|
||||
// Refer to the license.txt file included.
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <memory>
|
||||
#include <string>
|
||||
#include "core/file_sys/archive_backend.h"
|
||||
#include "core/hle/result.h"
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
// FileSys namespace
|
||||
|
||||
namespace FileSys {
|
||||
|
||||
/// A common source of SD save data archive
|
||||
class ArchiveSource_SDSaveData {
|
||||
public:
|
||||
explicit ArchiveSource_SDSaveData(const std::string& mount_point);
|
||||
|
||||
ResultVal<std::unique_ptr<ArchiveBackend>> Open(u64 program_id);
|
||||
ResultCode Format(u64 program_id, const FileSys::ArchiveFormatInfo& format_info);
|
||||
ResultVal<ArchiveFormatInfo> GetFormatInfo(u64 program_id) const;
|
||||
|
||||
private:
|
||||
std::string mount_point;
|
||||
};
|
||||
|
||||
} // namespace FileSys
|
|
@ -535,7 +535,8 @@ void RegisterArchiveTypes() {
|
|||
sdmc_directory.c_str());
|
||||
|
||||
// Create the SaveData archive
|
||||
auto savedata_factory = std::make_unique<FileSys::ArchiveFactory_SaveData>(sdmc_directory);
|
||||
auto sd_savedata_source = std::make_shared<FileSys::ArchiveSource_SDSaveData>(sdmc_directory);
|
||||
auto savedata_factory = std::make_unique<FileSys::ArchiveFactory_SaveData>(sd_savedata_source);
|
||||
RegisterArchiveType(std::move(savedata_factory), ArchiveIdCode::SaveData);
|
||||
|
||||
auto extsavedata_factory =
|
||||
|
|
Reference in New Issue