// Copyright 2014 Citra Emulator Project // Licensed under GPLv2 or any later version // Refer to the license.txt file included. #include #include #include #include "common/common_types.h" #include "common/file_util.h" #include "common/logging/log.h" #include "core/file_sys/disk_archive.h" //////////////////////////////////////////////////////////////////////////////////////////////////// // FileSys namespace namespace FileSys { ResultVal> DiskArchive::OpenFile(const Path& path, const Mode& mode) const { LOG_DEBUG(Service_FS, "called path=%s mode=%01X", path.DebugStr().c_str(), mode.hex); auto full_path = mount_point + path.AsString(); if (FileUtil::IsDirectory(full_path)) return ResultCode(ErrorDescription::FS_NotAFile, ErrorModule::FS, ErrorSummary::Canceled, ErrorLevel::Status); // Specifying only the Create flag is invalid if (mode.create_flag && !mode.read_flag && !mode.write_flag) { return ResultCode(ErrorDescription::FS_InvalidOpenFlags, ErrorModule::FS, ErrorSummary::Canceled, ErrorLevel::Status); } if (!FileUtil::Exists(full_path)) { if (!mode.create_flag) { LOG_ERROR(Service_FS, "Non-existing file %s can't be open without mode create.", full_path.c_str()); return ResultCode(ErrorDescription::FS_NotFound, ErrorModule::FS, ErrorSummary::NotFound, ErrorLevel::Status); } else { // Create the file FileUtil::CreateEmptyFile(full_path); } } std::string mode_string = ""; if (mode.write_flag) mode_string += "r+"; // Files opened with Write access can be read from else if (mode.read_flag) mode_string += "r"; // Open the file in binary mode, to avoid problems with CR/LF on Windows systems mode_string += "b"; FileUtil::IOFile file(full_path, mode_string.c_str()); if (!file.IsOpen()) return ResultCode(ErrorDescription::FS_NotFound, ErrorModule::FS, ErrorSummary::NotFound, ErrorLevel::Status); auto disk_file = std::make_unique(std::move(file), mode); return MakeResult>(std::move(disk_file)); } ResultCode DiskArchive::DeleteFile(const Path& path) const { std::string file_path = mount_point + path.AsString(); if (FileUtil::IsDirectory(file_path)) return ResultCode(ErrorDescription::FS_NotAFile, ErrorModule::FS, ErrorSummary::Canceled, ErrorLevel::Status); if (!FileUtil::Exists(file_path)) return ResultCode(ErrorDescription::FS_NotFound, ErrorModule::FS, ErrorSummary::NotFound, ErrorLevel::Status); if (FileUtil::Delete(file_path)) return RESULT_SUCCESS; return ResultCode(ErrorDescription::FS_NotAFile, ErrorModule::FS, ErrorSummary::Canceled, ErrorLevel::Status); } ResultCode DiskArchive::RenameFile(const Path& src_path, const Path& dest_path) const { if (FileUtil::Rename(mount_point + src_path.AsString(), mount_point + dest_path.AsString())) return RESULT_SUCCESS; // TODO(yuriks): This code probably isn't right, it'll return a Status even if the file didn't // exist or similar. Verify. return ResultCode(ErrorDescription::NoData, ErrorModule::FS, // TODO: verify description ErrorSummary::NothingHappened, ErrorLevel::Status); } ResultCode DiskArchive::DeleteDirectory(const Path& path) const { if (FileUtil::DeleteDir(mount_point + path.AsString())) return RESULT_SUCCESS; return ResultCode(ErrorDescription::NoData, ErrorModule::FS, // TODO: verify description ErrorSummary::Canceled, ErrorLevel::Status); } ResultCode DiskArchive::DeleteDirectoryRecursively(const Path& path) const { if (FileUtil::DeleteDirRecursively(mount_point + path.AsString())) return RESULT_SUCCESS; return ResultCode(ErrorDescription::NoData, ErrorModule::FS, // TODO: verify description ErrorSummary::Canceled, ErrorLevel::Status); } ResultCode DiskArchive::CreateFile(const FileSys::Path& path, u64 size) const { std::string full_path = mount_point + path.AsString(); if (FileUtil::IsDirectory(full_path)) return ResultCode(ErrorDescription::FS_NotAFile, ErrorModule::FS, ErrorSummary::Canceled, ErrorLevel::Status); if (FileUtil::Exists(full_path)) return ResultCode(ErrorDescription::FS_AlreadyExists, ErrorModule::FS, ErrorSummary::NothingHappened, ErrorLevel::Status); if (size == 0) { FileUtil::CreateEmptyFile(full_path); return RESULT_SUCCESS; } FileUtil::IOFile file(full_path, "wb"); // Creates a sparse file (or a normal file on filesystems without the concept of sparse files) // We do this by seeking to the right size, then writing a single null byte. if (file.Seek(size - 1, SEEK_SET) && file.WriteBytes("", 1) == 1) return RESULT_SUCCESS; return ResultCode(ErrorDescription::TooLarge, ErrorModule::FS, ErrorSummary::OutOfResource, ErrorLevel::Info); } ResultCode DiskArchive::CreateDirectory(const Path& path) const { if (FileUtil::CreateDir(mount_point + path.AsString())) return RESULT_SUCCESS; return ResultCode(ErrorDescription::NoData, ErrorModule::FS, // TODO: verify description ErrorSummary::Canceled, ErrorLevel::Status); } ResultCode DiskArchive::RenameDirectory(const Path& src_path, const Path& dest_path) const { if (FileUtil::Rename(mount_point + src_path.AsString(), mount_point + dest_path.AsString())) return RESULT_SUCCESS; // TODO(yuriks): This code probably isn't right, it'll return a Status even if the file didn't // exist or similar. Verify. return ResultCode(ErrorDescription::NoData, ErrorModule::FS, // TODO: verify description ErrorSummary::NothingHappened, ErrorLevel::Status); } ResultVal> DiskArchive::OpenDirectory(const Path& path) const { LOG_DEBUG(Service_FS, "called path=%s", path.DebugStr().c_str()); auto full_path = mount_point + path.AsString(); if (!FileUtil::IsDirectory(full_path)) return ResultCode(ErrorDescription::FS_NotFound, ErrorModule::FS, ErrorSummary::NotFound, ErrorLevel::Permanent); auto directory = std::make_unique(full_path); return MakeResult>(std::move(directory)); } u64 DiskArchive::GetFreeBytes() const { // TODO: Stubbed to return 1GiB return 1024 * 1024 * 1024; } //////////////////////////////////////////////////////////////////////////////////////////////////// ResultVal DiskFile::Read(const u64 offset, const size_t length, u8* buffer) const { if (!mode.read_flag) return ResultCode(ErrorDescription::FS_InvalidOpenFlags, ErrorModule::FS, ErrorSummary::Canceled, ErrorLevel::Status); file->Seek(offset, SEEK_SET); return MakeResult(file->ReadBytes(buffer, length)); } ResultVal DiskFile::Write(const u64 offset, const size_t length, const bool flush, const u8* buffer) const { if (!mode.write_flag) return ResultCode(ErrorDescription::FS_InvalidOpenFlags, ErrorModule::FS, ErrorSummary::Canceled, ErrorLevel::Status); file->Seek(offset, SEEK_SET); size_t written = file->WriteBytes(buffer, length); if (flush) file->Flush(); return MakeResult(written); } u64 DiskFile::GetSize() const { return file->GetSize(); } bool DiskFile::SetSize(const u64 size) const { file->Resize(size); file->Flush(); return true; } bool DiskFile::Close() const { return file->Close(); } //////////////////////////////////////////////////////////////////////////////////////////////////// DiskDirectory::DiskDirectory(const std::string& path) : directory() { unsigned size = FileUtil::ScanDirectoryTree(path, directory); directory.size = size; directory.isDirectory = true; children_iterator = directory.children.begin(); } u32 DiskDirectory::Read(const u32 count, Entry* entries) { u32 entries_read = 0; while (entries_read < count && children_iterator != directory.children.cend()) { const FileUtil::FSTEntry& file = *children_iterator; const std::string& filename = file.virtualName; Entry& entry = entries[entries_read]; LOG_TRACE(Service_FS, "File %s: size=%llu dir=%d", filename.c_str(), file.size, file.isDirectory); // TODO(Link Mauve): use a proper conversion to UTF-16. for (size_t j = 0; j < FILENAME_LENGTH; ++j) { entry.filename[j] = filename[j]; if (!filename[j]) break; } FileUtil::SplitFilename83(filename, entry.short_name, entry.extension); entry.is_directory = file.isDirectory; entry.is_hidden = (filename[0] == '.'); entry.is_read_only = 0; entry.file_size = file.size; // We emulate a SD card where the archive bit has never been cleared, as it would be on // most user SD cards. // Some homebrews (blargSNES for instance) are known to mistakenly use the archive bit as a // file bit. entry.is_archive = !file.isDirectory; ++entries_read; ++children_iterator; } return entries_read; } } // namespace FileSys