// Copyright 2014 Citra Emulator Project // Licensed under GPLv2 or any later version // Refer to the license.txt file included. #include #include #include #include #include #include "bad_word_list.app.romfs.h" #include "common/archives.h" #include "common/common_types.h" #include "common/file_util.h" #include "common/logging/log.h" #include "common/string_util.h" #include "common/swap.h" #include "core/core.h" #include "core/file_sys/archive_ncch.h" #include "core/file_sys/errors.h" #include "core/file_sys/ivfc_archive.h" #include "core/file_sys/ncch_container.h" #include "core/hle/service/am/am.h" #include "core/hle/service/fs/archive.h" #include "core/loader/loader.h" #include "country_list.app.romfs.h" #include "mii.app.romfs.h" #include "shared_font.app.romfs.h" //////////////////////////////////////////////////////////////////////////////////////////////////// // FileSys namespace SERIALIZE_EXPORT_IMPL(FileSys::NCCHArchive) SERIALIZE_EXPORT_IMPL(FileSys::NCCHFile) SERIALIZE_EXPORT_IMPL(FileSys::ArchiveFactory_NCCH) namespace FileSys { struct NCCHArchivePath { u64_le tid; u32_le media_type; u32_le unknown; }; static_assert(sizeof(NCCHArchivePath) == 0x10, "NCCHArchivePath has wrong size!"); struct NCCHFilePath { enum_le open_type; u32_le content_index; enum_le filepath_type; std::array exefs_filepath; }; static_assert(sizeof(NCCHFilePath) == 0x14, "NCCHFilePath has wrong size!"); Path MakeNCCHArchivePath(u64 tid, Service::FS::MediaType media_type) { NCCHArchivePath path; path.tid = static_cast(tid); path.media_type = static_cast(media_type); path.unknown = 0; std::vector archive(sizeof(path)); std::memcpy(archive.data(), &path, sizeof(path)); return FileSys::Path(std::move(archive)); } Path MakeNCCHFilePath(NCCHFileOpenType open_type, u32 content_index, NCCHFilePathType filepath_type, std::array& exefs_filepath) { NCCHFilePath path; path.open_type = open_type; path.content_index = static_cast(content_index); path.filepath_type = filepath_type; path.exefs_filepath = exefs_filepath; std::vector file(sizeof(path)); std::memcpy(file.data(), &path, sizeof(path)); return FileSys::Path(std::move(file)); } ResultVal> NCCHArchive::OpenFile(const Path& path, const Mode& mode) const { if (path.GetType() != LowPathType::Binary) { LOG_ERROR(Service_FS, "Path need to be Binary"); return ERROR_INVALID_PATH; } std::vector binary = path.AsBinary(); if (binary.size() != sizeof(NCCHFilePath)) { LOG_ERROR(Service_FS, "Wrong path size {}", binary.size()); return ERROR_INVALID_PATH; } NCCHFilePath openfile_path; std::memcpy(&openfile_path, binary.data(), sizeof(NCCHFilePath)); std::string file_path = Service::AM::GetTitleContentPath(media_type, title_id, openfile_path.content_index); auto ncch_container = NCCHContainer(file_path); Loader::ResultStatus result; std::unique_ptr file; // NCCH RomFS if (openfile_path.filepath_type == NCCHFilePathType::RomFS) { std::shared_ptr romfs_file; result = ncch_container.ReadRomFS(romfs_file); std::unique_ptr delay_generator = std::make_unique(); file = std::make_unique(std::move(romfs_file), std::move(delay_generator)); } else if (openfile_path.filepath_type == NCCHFilePathType::Code || openfile_path.filepath_type == NCCHFilePathType::ExeFS) { std::vector buffer; // Load NCCH .code or icon/banner/logo result = ncch_container.LoadSectionExeFS(openfile_path.exefs_filepath.data(), buffer); std::unique_ptr delay_generator = std::make_unique(); file = std::make_unique(std::move(buffer), std::move(delay_generator)); } else { LOG_ERROR(Service_FS, "Unknown NCCH archive type {}!", static_cast(openfile_path.filepath_type)); result = Loader::ResultStatus::Error; } if (result != Loader::ResultStatus::Success) { // High Title ID of the archive: The category (https://3dbrew.org/wiki/Title_list). constexpr u32 shared_data_archive = 0x0004009B; constexpr u32 system_data_archive = 0x000400DB; // Low Title IDs. constexpr u32 mii_data = 0x00010202; constexpr u32 region_manifest = 0x00010402; constexpr u32 ng_word_list = 0x00010302; constexpr u32 shared_font = 0x00014002; u32 high = static_cast(title_id >> 32); u32 low = static_cast(title_id & 0xFFFFFFFF); LOG_DEBUG(Service_FS, "Full Path: {}. Category: 0x{:X}. Path: 0x{:X}.", path.DebugStr(), high, low); std::vector archive_data; if (high == shared_data_archive) { if (low == mii_data) { LOG_WARNING(Service_FS, "Mii data file missing. Loading open source replacement from memory"); archive_data = std::vector(std::begin(MII_DATA), std::end(MII_DATA)); } else if (low == region_manifest) { LOG_WARNING( Service_FS, "Country list file missing. Loading open source replacement from memory"); archive_data = std::vector(std::begin(COUNTRY_LIST_DATA), std::end(COUNTRY_LIST_DATA)); } else if (low == shared_font) { LOG_WARNING( Service_FS, "Shared Font file missing. Loading open source replacement from memory"); archive_data = std::vector(std::begin(SHARED_FONT_DATA), std::end(SHARED_FONT_DATA)); } } else if (high == system_data_archive) { if (low == ng_word_list) { LOG_WARNING( Service_FS, "Bad Word List file missing. Loading open source replacement from memory"); archive_data = std::vector(std::begin(BAD_WORD_LIST_DATA), std::end(BAD_WORD_LIST_DATA)); } } if (!archive_data.empty()) { u64 romfs_offset = 0; u64 romfs_size = archive_data.size(); std::unique_ptr delay_generator = std::make_unique(); file = std::make_unique(std::move(archive_data), romfs_offset, romfs_size, std::move(delay_generator)); return MakeResult>(std::move(file)); } return ERROR_NOT_FOUND; } return MakeResult>(std::move(file)); } ResultCode NCCHArchive::DeleteFile(const Path& path) const { LOG_CRITICAL(Service_FS, "Attempted to delete a file from an NCCH archive ({}).", GetName()); // TODO(Subv): Verify error code return ResultCode(ErrorDescription::NoData, ErrorModule::FS, ErrorSummary::Canceled, ErrorLevel::Status); } ResultCode NCCHArchive::RenameFile(const Path& src_path, const Path& dest_path) const { LOG_CRITICAL(Service_FS, "Attempted to rename a file within an NCCH archive ({}).", GetName()); // TODO(wwylele): Use correct error code return ResultCode(-1); } ResultCode NCCHArchive::DeleteDirectory(const Path& path) const { LOG_CRITICAL(Service_FS, "Attempted to delete a directory from an NCCH archive ({}).", GetName()); // TODO(wwylele): Use correct error code return ResultCode(-1); } ResultCode NCCHArchive::DeleteDirectoryRecursively(const Path& path) const { LOG_CRITICAL(Service_FS, "Attempted to delete a directory from an NCCH archive ({}).", GetName()); // TODO(wwylele): Use correct error code return ResultCode(-1); } ResultCode NCCHArchive::CreateFile(const Path& path, u64 size) const { LOG_CRITICAL(Service_FS, "Attempted to create a file in an NCCH archive ({}).", GetName()); // TODO: Verify error code return ResultCode(ErrorDescription::NotAuthorized, ErrorModule::FS, ErrorSummary::NotSupported, ErrorLevel::Permanent); } ResultCode NCCHArchive::CreateDirectory(const Path& path) const { LOG_CRITICAL(Service_FS, "Attempted to create a directory in an NCCH archive ({}).", GetName()); // TODO(wwylele): Use correct error code return ResultCode(-1); } ResultCode NCCHArchive::RenameDirectory(const Path& src_path, const Path& dest_path) const { LOG_CRITICAL(Service_FS, "Attempted to rename a file within an NCCH archive ({}).", GetName()); // TODO(wwylele): Use correct error code return ResultCode(-1); } ResultVal> NCCHArchive::OpenDirectory(const Path& path) const { LOG_CRITICAL(Service_FS, "Attempted to open a directory within an NCCH archive ({}).", GetName().c_str()); // TODO(shinyquagsire23): Use correct error code return ResultCode(-1); } u64 NCCHArchive::GetFreeBytes() const { LOG_WARNING(Service_FS, "Attempted to get the free space in an NCCH archive"); return 0; } //////////////////////////////////////////////////////////////////////////////////////////////////// NCCHFile::NCCHFile(std::vector buffer, std::unique_ptr delay_generator_) : file_buffer(std::move(buffer)) { delay_generator = std::move(delay_generator_); } ResultVal NCCHFile::Read(const u64 offset, const std::size_t length, u8* buffer) const { LOG_TRACE(Service_FS, "called offset={}, length={}", offset, length); std::size_t available_size = static_cast(file_buffer.size() - offset); std::size_t copy_size = std::min(length, available_size); memcpy(buffer, file_buffer.data() + offset, copy_size); return MakeResult(copy_size); } ResultVal NCCHFile::Write(const u64 offset, const std::size_t length, const bool flush, const u8* buffer) { LOG_ERROR(Service_FS, "Attempted to write to NCCH file"); // TODO(shinyquagsire23): Find error code return MakeResult(0); } u64 NCCHFile::GetSize() const { return file_buffer.size(); } bool NCCHFile::SetSize(const u64 size) const { LOG_ERROR(Service_FS, "Attempted to set the size of an NCCH file"); return false; } //////////////////////////////////////////////////////////////////////////////////////////////////// ArchiveFactory_NCCH::ArchiveFactory_NCCH() {} ResultVal> ArchiveFactory_NCCH::Open(const Path& path, u64 program_id) { if (path.GetType() != LowPathType::Binary) { LOG_ERROR(Service_FS, "Path need to be Binary"); return ERROR_INVALID_PATH; } std::vector binary = path.AsBinary(); if (binary.size() != sizeof(NCCHArchivePath)) { LOG_ERROR(Service_FS, "Wrong path size {}", binary.size()); return ERROR_INVALID_PATH; } NCCHArchivePath open_path; std::memcpy(&open_path, binary.data(), sizeof(NCCHArchivePath)); auto archive = std::make_unique( open_path.tid, static_cast(open_path.media_type & 0xFF)); return MakeResult>(std::move(archive)); } ResultCode ArchiveFactory_NCCH::Format(const Path& path, const FileSys::ArchiveFormatInfo& format_info, u64 program_id) { LOG_ERROR(Service_FS, "Attempted to format a NCCH archive."); // TODO: Verify error code return ResultCode(ErrorDescription::NotAuthorized, ErrorModule::FS, ErrorSummary::NotSupported, ErrorLevel::Permanent); } ResultVal ArchiveFactory_NCCH::GetFormatInfo(const Path& path, u64 program_id) const { // TODO(Subv): Implement LOG_ERROR(Service_FS, "Unimplemented GetFormatInfo archive {}", GetName()); return ResultCode(-1); } } // namespace FileSys