azahar/src/core/loader/loader.cpp

242 lines
8.6 KiB
C++

// Copyright Citra Emulator Project / Azahar Emulator Project
// Licensed under GPLv2 or any later version
// Refer to the license.txt file included.
#include <memory>
#include <string>
#include "common/logging/log.h"
#include "common/string_util.h"
#include "common/zstd_compression.h"
#include "core/core.h"
#include "core/hle/kernel/process.h"
#include "core/hle/service/am/am.h"
#include "core/loader/3dsx.h"
#include "core/loader/artic.h"
#include "core/loader/elf.h"
#include "core/loader/ncch.h"
namespace Loader {
FileType IdentifyFile(FileUtil::IOFile& file) {
FileType type;
#define CHECK_TYPE(loader) \
type = AppLoader_##loader::IdentifyType(&file); \
if (FileType::Error != type) \
return type;
CHECK_TYPE(THREEDSX)
CHECK_TYPE(ELF)
CHECK_TYPE(NCCH)
#undef CHECK_TYPE
return FileType::Unknown;
}
FileType IdentifyFile(const std::string& file_name) {
FileUtil::IOFile file(file_name, "rb");
if (!file.IsOpen()) {
LOG_ERROR(Loader, "Failed to load file {}", file_name);
return FileType::Unknown;
}
return IdentifyFile(file);
}
FileType GuessFromExtension(const std::string& extension_) {
std::string extension = Common::ToLower(extension_);
if (extension == ".elf" || extension == ".axf")
return FileType::ELF;
if (extension == ".cci" || extension == ".zcci" || extension == ".3ds")
return FileType::CCI;
if (extension == ".cxi" || extension == ".app" || extension == ".zcxi")
return FileType::CXI;
if (extension == ".3dsx" || extension == ".z3dsx")
return FileType::THREEDSX;
if (extension == ".cia" || extension == ".zcia")
return FileType::CIA;
return FileType::Unknown;
}
const char* GetFileTypeString(FileType type, bool is_compressed) {
switch (type) {
case FileType::CCI:
return is_compressed ? "NCSD (Z)" : "NCSD";
case FileType::CXI:
return is_compressed ? "NCCH (Z)" : "NCCH";
case FileType::CIA:
return is_compressed ? "CIA (Z)" : "CIA";
case FileType::ELF:
return "ELF";
case FileType::THREEDSX:
return is_compressed ? "3DSX (Z)" : "3DSX";
case FileType::ARTIC:
return "ARTIC";
case FileType::Error:
case FileType::Unknown:
break;
}
return "unknown";
}
/**
* Get a loader for a file with a specific type
* @param file The file to load
* @param type The type of the file
* @param filename the file name (without path)
* @param filepath the file full path (with name)
* @return std::unique_ptr<AppLoader> a pointer to a loader object; nullptr for unsupported type
*/
static std::unique_ptr<AppLoader> GetFileLoader(Core::System& system, FileUtil::IOFile&& file,
FileType type, const std::string& filename,
const std::string& filepath) {
switch (type) {
// 3DSX file format.
case FileType::THREEDSX:
return std::make_unique<AppLoader_THREEDSX>(system, std::move(file), filename, filepath);
// Standard ELF file format.
case FileType::ELF:
return std::make_unique<AppLoader_ELF>(system, std::move(file), filename);
// NCCH/NCSD container formats.
case FileType::CXI:
case FileType::CCI:
return std::make_unique<AppLoader_NCCH>(system, std::move(file), filepath);
case FileType::ARTIC: {
Apploader_Artic::ArticInitMode mode = Apploader_Artic::ArticInitMode::NONE;
if (filename.starts_with("articinio://")) {
mode = Apploader_Artic::ArticInitMode::O3DS;
} else if (filename.starts_with("articinin://")) {
mode = Apploader_Artic::ArticInitMode::N3DS;
}
auto strToUInt = [](const std::string& str) -> int {
char* pEnd = NULL;
unsigned long ul = ::strtoul(str.c_str(), &pEnd, 10);
if (*pEnd)
return -1;
return static_cast<int>(ul);
};
u16 port = 5543;
std::string server_addr = filename.substr(12);
auto pos = server_addr.find(":");
if (pos != server_addr.npos) {
int newVal = strToUInt(server_addr.substr(pos + 1));
if (newVal >= 0 && newVal <= 0xFFFF) {
port = static_cast<u16>(newVal);
server_addr = server_addr.substr(0, pos);
}
}
return std::make_unique<Apploader_Artic>(system, server_addr, port, mode);
}
default:
return nullptr;
}
}
std::unique_ptr<AppLoader> GetLoader(const std::string& filename) {
if (filename.starts_with("articbase://") || filename.starts_with("articinio://") ||
filename.starts_with("articinin://")) {
return GetFileLoader(Core::System::GetInstance(), FileUtil::IOFile(), FileType::ARTIC,
filename, "");
}
FileUtil::IOFile file(filename, "rb");
if (!file.IsOpen()) {
LOG_ERROR(Loader, "Failed to load file {}", filename);
return nullptr;
}
std::string filename_filename, filename_extension;
Common::SplitPath(filename, nullptr, &filename_filename, &filename_extension);
FileType type = IdentifyFile(file);
FileType filename_type = GuessFromExtension(filename_extension);
if (type != filename_type) {
// Do not show the error for CIA files, as their type cannot be determined.
if (!(type == FileType::Unknown && filename_type == FileType::CIA)) {
LOG_WARNING(Loader, "File {} has a different type than its extension.", filename);
}
if (FileType::Unknown == type)
type = filename_type;
}
LOG_DEBUG(Loader, "Loading file {} as {}...", filename, GetFileTypeString(type));
auto& system = Core::System::GetInstance();
return GetFileLoader(system, std::move(file), type, filename_filename, filename);
}
std::optional<std::pair<Loader::AppLoader::CompressFileInfo, size_t>> GetCompressFileInfo(
const std::string& filepath, bool compress) {
Loader::AppLoader::CompressFileInfo compress_info{};
compress_info.is_supported = false;
size_t frame_size{};
auto loader = Loader::GetLoader(filepath);
if (loader) {
compress_info = loader->GetCompressFileInfo();
frame_size = FileUtil::Z3DSWriteIOFile::DEFAULT_FRAME_SIZE;
} else {
bool is_compressed = false;
if (Service::AM::CheckCIAToInstall(filepath, is_compressed, compress ? true : false) ==
Service::AM::InstallStatus::Success) {
compress_info.is_supported = true;
compress_info.is_compressed = is_compressed;
compress_info.recommended_compressed_extension = "zcia";
compress_info.recommended_uncompressed_extension = "cia";
compress_info.underlying_magic = std::array<u8, 4>({'C', 'I', 'A', '\0'});
frame_size = FileUtil::Z3DSWriteIOFile::DEFAULT_CIA_FRAME_SIZE;
if (compress) {
auto meta_info = Service::AM::GetCIAInfos(filepath);
if (meta_info.Succeeded()) {
const auto& meta_info_val = meta_info.Unwrap();
std::vector<u8> value(sizeof(Service::AM::TitleInfo));
memcpy(value.data(), &meta_info_val.first, sizeof(Service::AM::TitleInfo));
compress_info.default_metadata.emplace("titleinfo", value);
if (meta_info_val.second) {
value.resize(sizeof(Loader::SMDH));
memcpy(value.data(), meta_info_val.second.get(), sizeof(Loader::SMDH));
compress_info.default_metadata.emplace("smdh", value);
}
}
}
}
}
if (!compress_info.is_supported) {
LOG_ERROR(Frontend,
"Error {} file {}, the selected file is not a compatible 3DS ROM format or is "
"encrypted.",
compress ? "compressing" : "decompressing", filepath);
return {};
}
if (compress_info.is_compressed && compress) {
LOG_ERROR(Frontend, "Error compressing file {}, the selected file is already compressed",
filepath);
return {};
}
if (!compress_info.is_compressed && !compress) {
LOG_ERROR(Frontend,
"Error decompressing file {}, the selected file is already decompressed",
filepath);
return {};
}
return std::pair(compress_info, frame_size);
}
} // namespace Loader