From 065867e2c24e9856c360fc2d6b9a86c92aedc43e Mon Sep 17 00:00:00 2001
From: Morph <39850852+Morph1984@users.noreply.github.com>
Date: Tue, 25 May 2021 19:32:56 -0400
Subject: common: fs: Rework the Common Filesystem interface to make use of
std::filesystem (#6270)
* common: fs: fs_types: Create filesystem types
Contains various filesystem types used by the Common::FS library
* common: fs: fs_util: Add std::string to std::u8string conversion utility
* common: fs: path_util: Add utlity functions for paths
Contains various utility functions for getting or manipulating filesystem paths used by the Common::FS library
* common: fs: file: Rewrite the IOFile implementation
* common: fs: Reimplement Common::FS library using std::filesystem
* common: fs: fs_paths: Add fs_paths to replace common_paths
* common: fs: path_util: Add the rest of the path functions
* common: Remove the previous Common::FS implementation
* general: Remove unused fs includes
* string_util: Remove unused function and include
* nvidia_flags: Migrate to the new Common::FS library
* settings: Migrate to the new Common::FS library
* logging: backend: Migrate to the new Common::FS library
* core: Migrate to the new Common::FS library
* perf_stats: Migrate to the new Common::FS library
* reporter: Migrate to the new Common::FS library
* telemetry_session: Migrate to the new Common::FS library
* key_manager: Migrate to the new Common::FS library
* bis_factory: Migrate to the new Common::FS library
* registered_cache: Migrate to the new Common::FS library
* xts_archive: Migrate to the new Common::FS library
* service: acc: Migrate to the new Common::FS library
* applets/profile: Migrate to the new Common::FS library
* applets/web: Migrate to the new Common::FS library
* service: filesystem: Migrate to the new Common::FS library
* loader: Migrate to the new Common::FS library
* gl_shader_disk_cache: Migrate to the new Common::FS library
* nsight_aftermath_tracker: Migrate to the new Common::FS library
* vulkan_library: Migrate to the new Common::FS library
* configure_debug: Migrate to the new Common::FS library
* game_list_worker: Migrate to the new Common::FS library
* config: Migrate to the new Common::FS library
* configure_filesystem: Migrate to the new Common::FS library
* configure_per_game_addons: Migrate to the new Common::FS library
* configure_profile_manager: Migrate to the new Common::FS library
* configure_ui: Migrate to the new Common::FS library
* input_profiles: Migrate to the new Common::FS library
* yuzu_cmd: config: Migrate to the new Common::FS library
* yuzu_cmd: Migrate to the new Common::FS library
* vfs_real: Migrate to the new Common::FS library
* vfs: Migrate to the new Common::FS library
* vfs_libzip: Migrate to the new Common::FS library
* service: bcat: Migrate to the new Common::FS library
* yuzu: main: Migrate to the new Common::FS library
* vfs_real: Delete the contents of an existing file in CreateFile
Current usages of CreateFile expect to delete the contents of an existing file, retain this behavior for now.
* input_profiles: Don't iterate the input profile dir if it does not exist
Silences an error produced in the log if the directory does not exist.
* game_list_worker: Skip parsing file if the returned VfsFile is nullptr
Prevents crashes in GetLoader when the virtual file is nullptr
* common: fs: Validate paths for path length
* service: filesystem: Open the mod load directory as read only
---
src/common/file_util.cpp | 1032 ----------------------------------------------
1 file changed, 1032 deletions(-)
delete mode 100644 src/common/file_util.cpp
(limited to 'src/common/file_util.cpp')
diff --git a/src/common/file_util.cpp b/src/common/file_util.cpp
deleted file mode 100644
index 18fbfa25bf..0000000000
--- a/src/common/file_util.cpp
+++ /dev/null
@@ -1,1032 +0,0 @@
-// Copyright 2013 Dolphin Emulator Project / 2014 Citra Emulator Project
-// Licensed under GPLv2 or any later version
-// Refer to the license.txt file included.
-
-#include <array>
-#include <limits>
-#include <memory>
-#include <sstream>
-#include <unordered_map>
-#include "common/assert.h"
-#include "common/common_funcs.h"
-#include "common/common_paths.h"
-#include "common/file_util.h"
-#include "common/logging/log.h"
-
-#ifdef _WIN32
-#include <windows.h>
-// windows.h needs to be included before other windows headers
-#include <direct.h> // getcwd
-#include <io.h>
-#include <shellapi.h>
-#include <shlobj.h> // for SHGetFolderPath
-#include <tchar.h>
-#include "common/string_util.h"
-
-#ifdef _MSC_VER
-// 64 bit offsets for MSVC
-#define fseeko _fseeki64
-#define ftello _ftelli64
-#define fileno _fileno
-#endif
-
-// 64 bit offsets for MSVC and MinGW. MinGW also needs this for using _wstat64
-#define stat _stat64
-#define fstat _fstat64
-
-#else
-#ifdef __APPLE__
-#include <sys/param.h>
-#endif
-#include <cctype>
-#include <cerrno>
-#include <cstdlib>
-#include <cstring>
-#include <dirent.h>
-#include <pwd.h>
-#include <unistd.h>
-#endif
-
-#if defined(__APPLE__)
-// CFURL contains __attribute__ directives that gcc does not know how to parse, so we need to just
-// ignore them if we're not using clang. The macro is only used to prevent linking against
-// functions that don't exist on older versions of macOS, and the worst case scenario is a linker
-// error, so this is perfectly safe, just inconvenient.
-#ifndef __clang__
-#define availability(...)
-#endif
-#include <CoreFoundation/CFBundle.h>
-#include <CoreFoundation/CFString.h>
-#include <CoreFoundation/CFURL.h>
-#ifdef availability
-#undef availability
-#endif
-
-#endif
-
-#include <algorithm>
-#include <sys/stat.h>
-
-#ifndef S_ISDIR
-#define S_ISDIR(m) (((m)&S_IFMT) == S_IFDIR)
-#endif
-
-// This namespace has various generic functions related to files and paths.
-// The code still needs a ton of cleanup.
-// REMEMBER: strdup considered harmful!
-namespace Common::FS {
-
-// Remove any ending forward slashes from directory paths
-// Modifies argument.
-static void StripTailDirSlashes(std::string& fname) {
- if (fname.length() <= 1) {
- return;
- }
-
- std::size_t i = fname.length();
- while (i > 0 && fname[i - 1] == DIR_SEP_CHR) {
- --i;
- }
- fname.resize(i);
-}
-
-bool Exists(const std::string& filename) {
- struct stat file_info;
-
- std::string copy(filename);
- StripTailDirSlashes(copy);
-
-#ifdef _WIN32
- // Windows needs a slash to identify a driver root
- if (copy.size() != 0 && copy.back() == ':')
- copy += DIR_SEP_CHR;
-
- int result = _wstat64(Common::UTF8ToUTF16W(copy).c_str(), &file_info);
-#else
- int result = stat(copy.c_str(), &file_info);
-#endif
-
- return (result == 0);
-}
-
-bool IsDirectory(const std::string& filename) {
- struct stat file_info;
-
- std::string copy(filename);
- StripTailDirSlashes(copy);
-
-#ifdef _WIN32
- // Windows needs a slash to identify a driver root
- if (copy.size() != 0 && copy.back() == ':')
- copy += DIR_SEP_CHR;
-
- int result = _wstat64(Common::UTF8ToUTF16W(copy).c_str(), &file_info);
-#else
- int result = stat(copy.c_str(), &file_info);
-#endif
-
- if (result < 0) {
- LOG_DEBUG(Common_Filesystem, "stat failed on {}: {}", filename, GetLastErrorMsg());
- return false;
- }
-
- return S_ISDIR(file_info.st_mode);
-}
-
-bool Delete(const std::string& filename) {
- LOG_TRACE(Common_Filesystem, "file {}", filename);
-
- // Return true because we care about the file no
- // being there, not the actual delete.
- if (!Exists(filename)) {
- LOG_DEBUG(Common_Filesystem, "{} does not exist", filename);
- return true;
- }
-
- // We can't delete a directory
- if (IsDirectory(filename)) {
- LOG_ERROR(Common_Filesystem, "Failed: {} is a directory", filename);
- return false;
- }
-
-#ifdef _WIN32
- if (!DeleteFileW(Common::UTF8ToUTF16W(filename).c_str())) {
- LOG_ERROR(Common_Filesystem, "DeleteFile failed on {}: {}", filename, GetLastErrorMsg());
- return false;
- }
-#else
- if (unlink(filename.c_str()) == -1) {
- LOG_ERROR(Common_Filesystem, "unlink failed on {}: {}", filename, GetLastErrorMsg());
- return false;
- }
-#endif
-
- return true;
-}
-
-bool CreateDir(const std::string& path) {
- LOG_TRACE(Common_Filesystem, "directory {}", path);
-#ifdef _WIN32
- if (::CreateDirectoryW(Common::UTF8ToUTF16W(path).c_str(), nullptr))
- return true;
- DWORD error = GetLastError();
- if (error == ERROR_ALREADY_EXISTS) {
- LOG_DEBUG(Common_Filesystem, "CreateDirectory failed on {}: already exists", path);
- return true;
- }
- LOG_ERROR(Common_Filesystem, "CreateDirectory failed on {}: {}", path, error);
- return false;
-#else
- if (mkdir(path.c_str(), 0755) == 0)
- return true;
-
- int err = errno;
-
- if (err == EEXIST) {
- LOG_DEBUG(Common_Filesystem, "mkdir failed on {}: already exists", path);
- return true;
- }
-
- LOG_ERROR(Common_Filesystem, "mkdir failed on {}: {}", path, strerror(err));
- return false;
-#endif
-}
-
-bool CreateFullPath(const std::string& fullPath) {
- int panicCounter = 100;
- LOG_TRACE(Common_Filesystem, "path {}", fullPath);
-
- if (Exists(fullPath)) {
- LOG_DEBUG(Common_Filesystem, "path exists {}", fullPath);
- return true;
- }
-
- std::size_t position = 0;
- while (true) {
- // Find next sub path
- position = fullPath.find(DIR_SEP_CHR, position);
-
- // we're done, yay!
- if (position == fullPath.npos)
- return true;
-
- // Include the '/' so the first call is CreateDir("/") rather than CreateDir("")
- std::string const subPath(fullPath.substr(0, position + 1));
- if (!IsDirectory(subPath) && !CreateDir(subPath)) {
- LOG_ERROR(Common, "CreateFullPath: directory creation failed");
- return false;
- }
-
- // A safety check
- panicCounter--;
- if (panicCounter <= 0) {
- LOG_ERROR(Common, "CreateFullPath: directory structure is too deep");
- return false;
- }
- position++;
- }
-}
-
-bool DeleteDir(const std::string& filename) {
- LOG_TRACE(Common_Filesystem, "directory {}", filename);
-
- // check if a directory
- if (!IsDirectory(filename)) {
- LOG_ERROR(Common_Filesystem, "Not a directory {}", filename);
- return false;
- }
-
-#ifdef _WIN32
- if (::RemoveDirectoryW(Common::UTF8ToUTF16W(filename).c_str()))
- return true;
-#else
- if (rmdir(filename.c_str()) == 0)
- return true;
-#endif
- LOG_ERROR(Common_Filesystem, "failed {}: {}", filename, GetLastErrorMsg());
-
- return false;
-}
-
-bool Rename(const std::string& srcFilename, const std::string& destFilename) {
- LOG_TRACE(Common_Filesystem, "{} --> {}", srcFilename, destFilename);
-#ifdef _WIN32
- if (_wrename(Common::UTF8ToUTF16W(srcFilename).c_str(),
- Common::UTF8ToUTF16W(destFilename).c_str()) == 0)
- return true;
-#else
- if (rename(srcFilename.c_str(), destFilename.c_str()) == 0)
- return true;
-#endif
- LOG_ERROR(Common_Filesystem, "failed {} --> {}: {}", srcFilename, destFilename,
- GetLastErrorMsg());
- return false;
-}
-
-bool Copy(const std::string& srcFilename, const std::string& destFilename) {
- LOG_TRACE(Common_Filesystem, "{} --> {}", srcFilename, destFilename);
-#ifdef _WIN32
- if (CopyFileW(Common::UTF8ToUTF16W(srcFilename).c_str(),
- Common::UTF8ToUTF16W(destFilename).c_str(), FALSE))
- return true;
-
- LOG_ERROR(Common_Filesystem, "failed {} --> {}: {}", srcFilename, destFilename,
- GetLastErrorMsg());
- return false;
-#else
- using CFilePointer = std::unique_ptr<FILE, decltype(&std::fclose)>;
-
- // Open input file
- CFilePointer input{fopen(srcFilename.c_str(), "rb"), std::fclose};
- if (!input) {
- LOG_ERROR(Common_Filesystem, "opening input failed {} --> {}: {}", srcFilename,
- destFilename, GetLastErrorMsg());
- return false;
- }
-
- // open output file
- CFilePointer output{fopen(destFilename.c_str(), "wb"), std::fclose};
- if (!output) {
- LOG_ERROR(Common_Filesystem, "opening output failed {} --> {}: {}", srcFilename,
- destFilename, GetLastErrorMsg());
- return false;
- }
-
- // copy loop
- std::array<char, 1024> buffer;
- while (!feof(input.get())) {
- // read input
- std::size_t rnum = fread(buffer.data(), sizeof(char), buffer.size(), input.get());
- if (rnum != buffer.size()) {
- if (ferror(input.get()) != 0) {
- LOG_ERROR(Common_Filesystem, "failed reading from source, {} --> {}: {}",
- srcFilename, destFilename, GetLastErrorMsg());
- return false;
- }
- }
-
- // write output
- std::size_t wnum = fwrite(buffer.data(), sizeof(char), rnum, output.get());
- if (wnum != rnum) {
- LOG_ERROR(Common_Filesystem, "failed writing to output, {} --> {}: {}", srcFilename,
- destFilename, GetLastErrorMsg());
- return false;
- }
- }
-
- return true;
-#endif
-}
-
-u64 GetSize(const std::string& filename) {
- if (!Exists(filename)) {
- LOG_ERROR(Common_Filesystem, "failed {}: No such file", filename);
- return 0;
- }
-
- if (IsDirectory(filename)) {
- LOG_ERROR(Common_Filesystem, "failed {}: is a directory", filename);
- return 0;
- }
-
- struct stat buf;
-#ifdef _WIN32
- if (_wstat64(Common::UTF8ToUTF16W(filename).c_str(), &buf) == 0)
-#else
- if (stat(filename.c_str(), &buf) == 0)
-#endif
- {
- LOG_TRACE(Common_Filesystem, "{}: {}", filename, buf.st_size);
- return buf.st_size;
- }
-
- LOG_ERROR(Common_Filesystem, "Stat failed {}: {}", filename, GetLastErrorMsg());
- return 0;
-}
-
-u64 GetSize(const int fd) {
- struct stat buf;
- if (fstat(fd, &buf) != 0) {
- LOG_ERROR(Common_Filesystem, "GetSize: stat failed {}: {}", fd, GetLastErrorMsg());
- return 0;
- }
- return buf.st_size;
-}
-
-u64 GetSize(FILE* f) {
- // can't use off_t here because it can be 32-bit
- u64 pos = ftello(f);
- if (fseeko(f, 0, SEEK_END) != 0) {
- LOG_ERROR(Common_Filesystem, "GetSize: seek failed {}: {}", fmt::ptr(f), GetLastErrorMsg());
- return 0;
- }
- u64 size = ftello(f);
- if ((size != pos) && (fseeko(f, pos, SEEK_SET) != 0)) {
- LOG_ERROR(Common_Filesystem, "GetSize: seek failed {}: {}", fmt::ptr(f), GetLastErrorMsg());
- return 0;
- }
- return size;
-}
-
-bool CreateEmptyFile(const std::string& filename) {
- LOG_TRACE(Common_Filesystem, "{}", filename);
-
- if (!IOFile(filename, "wb").IsOpen()) {
- LOG_ERROR(Common_Filesystem, "failed {}: {}", filename, GetLastErrorMsg());
- return false;
- }
-
- return true;
-}
-
-bool ForeachDirectoryEntry(u64* num_entries_out, const std::string& directory,
- DirectoryEntryCallable callback) {
- LOG_TRACE(Common_Filesystem, "directory {}", directory);
-
- // How many files + directories we found
- u64 found_entries = 0;
-
- // Save the status of callback function
- bool callback_error = false;
-
-#ifdef _WIN32
- // Find the first file in the directory.
- WIN32_FIND_DATAW ffd;
-
- HANDLE handle_find = FindFirstFileW(Common::UTF8ToUTF16W(directory + "\\*").c_str(), &ffd);
- if (handle_find == INVALID_HANDLE_VALUE) {
- FindClose(handle_find);
- return false;
- }
- // windows loop
- do {
- const std::string virtual_name(Common::UTF16ToUTF8(ffd.cFileName));
-#else
- DIR* dirp = opendir(directory.c_str());
- if (!dirp)
- return false;
-
- // non windows loop
- while (struct dirent* result = readdir(dirp)) {
- const std::string virtual_name(result->d_name);
-#endif
-
- if (virtual_name == "." || virtual_name == "..")
- continue;
-
- u64 ret_entries = 0;
- if (!callback(&ret_entries, directory, virtual_name)) {
- callback_error = true;
- break;
- }
- found_entries += ret_entries;
-
-#ifdef _WIN32
- } while (FindNextFileW(handle_find, &ffd) != 0);
- FindClose(handle_find);
-#else
- }
- closedir(dirp);
-#endif
-
- if (callback_error)
- return false;
-
- // num_entries_out is allowed to be specified nullptr, in which case we shouldn't try to set it
- if (num_entries_out != nullptr)
- *num_entries_out = found_entries;
- return true;
-}
-
-u64 ScanDirectoryTree(const std::string& directory, FSTEntry& parent_entry,
- unsigned int recursion) {
- const auto callback = [recursion, &parent_entry](u64* num_entries_out,
- const std::string& directory,
- const std::string& virtual_name) -> bool {
- FSTEntry entry;
- entry.virtualName = virtual_name;
- entry.physicalName = directory + DIR_SEP + virtual_name;
-
- if (IsDirectory(entry.physicalName)) {
- entry.isDirectory = true;
- // is a directory, lets go inside if we didn't recurse to often
- if (recursion > 0) {
- entry.size = ScanDirectoryTree(entry.physicalName, entry, recursion - 1);
- *num_entries_out += entry.size;
- } else {
- entry.size = 0;
- }
- } else { // is a file
- entry.isDirectory = false;
- entry.size = GetSize(entry.physicalName);
- }
- (*num_entries_out)++;
-
- // Push into the tree
- parent_entry.children.push_back(std::move(entry));
- return true;
- };
-
- u64 num_entries;
- return ForeachDirectoryEntry(&num_entries, directory, callback) ? num_entries : 0;
-}
-
-bool DeleteDirRecursively(const std::string& directory, unsigned int recursion) {
- const auto callback = [recursion](u64*, const std::string& directory,
- const std::string& virtual_name) {
- const std::string new_path = directory + DIR_SEP_CHR + virtual_name;
-
- if (IsDirectory(new_path)) {
- if (recursion == 0) {
- return false;
- }
- return DeleteDirRecursively(new_path, recursion - 1);
- }
- return Delete(new_path);
- };
-
- if (!ForeachDirectoryEntry(nullptr, directory, callback))
- return false;
-
- // Delete the outermost directory
- DeleteDir(directory);
- return true;
-}
-
-void CopyDir([[maybe_unused]] const std::string& source_path,
- [[maybe_unused]] const std::string& dest_path) {
-#ifndef _WIN32
- if (source_path == dest_path) {
- return;
- }
- if (!Exists(source_path)) {
- return;
- }
- if (!Exists(dest_path)) {
- CreateFullPath(dest_path);
- }
-
- DIR* dirp = opendir(source_path.c_str());
- if (!dirp) {
- return;
- }
-
- while (struct dirent* result = readdir(dirp)) {
- const std::string virtualName(result->d_name);
- // check for "." and ".."
- if (((virtualName[0] == '.') && (virtualName[1] == '\0')) ||
- ((virtualName[0] == '.') && (virtualName[1] == '.') && (virtualName[2] == '\0'))) {
- continue;
- }
-
- std::string source, dest;
- source = source_path + virtualName;
- dest = dest_path + virtualName;
- if (IsDirectory(source)) {
- source += '/';
- dest += '/';
- if (!Exists(dest)) {
- CreateFullPath(dest);
- }
- CopyDir(source, dest);
- } else if (!Exists(dest)) {
- Copy(source, dest);
- }
- }
- closedir(dirp);
-#endif
-}
-
-std::optional<std::string> GetCurrentDir() {
-// Get the current working directory (getcwd uses malloc)
-#ifdef _WIN32
- wchar_t* dir = _wgetcwd(nullptr, 0);
- if (!dir) {
-#else
- char* dir = getcwd(nullptr, 0);
- if (!dir) {
-#endif
- LOG_ERROR(Common_Filesystem, "GetCurrentDirectory failed: {}", GetLastErrorMsg());
- return std::nullopt;
- }
-#ifdef _WIN32
- std::string strDir = Common::UTF16ToUTF8(dir);
-#else
- std::string strDir = dir;
-#endif
- free(dir);
- return strDir;
-}
-
-bool SetCurrentDir(const std::string& directory) {
-#ifdef _WIN32
- return _wchdir(Common::UTF8ToUTF16W(directory).c_str()) == 0;
-#else
- return chdir(directory.c_str()) == 0;
-#endif
-}
-
-#if defined(__APPLE__)
-std::string GetBundleDirectory() {
- CFURLRef BundleRef;
- char AppBundlePath[MAXPATHLEN];
- // Get the main bundle for the app
- BundleRef = CFBundleCopyBundleURL(CFBundleGetMainBundle());
- CFStringRef BundlePath = CFURLCopyFileSystemPath(BundleRef, kCFURLPOSIXPathStyle);
- CFStringGetFileSystemRepresentation(BundlePath, AppBundlePath, sizeof(AppBundlePath));
- CFRelease(BundleRef);
- CFRelease(BundlePath);
-
- return AppBundlePath;
-}
-#endif
-
-#ifdef _WIN32
-const std::string& GetExeDirectory() {
- static std::string exe_path;
- if (exe_path.empty()) {
- wchar_t wchar_exe_path[2048];
- GetModuleFileNameW(nullptr, wchar_exe_path, 2048);
- exe_path = Common::UTF16ToUTF8(wchar_exe_path);
- exe_path = exe_path.substr(0, exe_path.find_last_of('\\'));
- }
- return exe_path;
-}
-
-std::string AppDataRoamingDirectory() {
- PWSTR pw_local_path = nullptr;
- // Only supported by Windows Vista or later
- SHGetKnownFolderPath(FOLDERID_RoamingAppData, 0, nullptr, &pw_local_path);
- std::string local_path = Common::UTF16ToUTF8(pw_local_path);
- CoTaskMemFree(pw_local_path);
- return local_path;
-}
-#else
-/**
- * @return The user’s home directory on POSIX systems
- */
-static const std::string& GetHomeDirectory() {
- static std::string home_path;
- if (home_path.empty()) {
- const char* envvar = getenv("HOME");
- if (envvar) {
- home_path = envvar;
- } else {
- auto pw = getpwuid(getuid());
- ASSERT_MSG(pw,
- "$HOME isn’t defined, and the current user can’t be found in /etc/passwd.");
- home_path = pw->pw_dir;
- }
- }
- return home_path;
-}
-
-/**
- * Follows the XDG Base Directory Specification to get a directory path
- * @param envvar The XDG environment variable to get the value from
- * @return The directory path
- * @sa http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
- */
-static const std::string GetUserDirectory(const std::string& envvar) {
- const char* directory = getenv(envvar.c_str());
-
- std::string user_dir;
- if (directory) {
- user_dir = directory;
- } else {
- std::string subdirectory;
- if (envvar == "XDG_DATA_HOME")
- subdirectory = DIR_SEP ".local" DIR_SEP "share";
- else if (envvar == "XDG_CONFIG_HOME")
- subdirectory = DIR_SEP ".config";
- else if (envvar == "XDG_CACHE_HOME")
- subdirectory = DIR_SEP ".cache";
- else
- ASSERT_MSG(false, "Unknown XDG variable {}.", envvar);
- user_dir = GetHomeDirectory() + subdirectory;
- }
-
- ASSERT_MSG(!user_dir.empty(), "User directory {} mustn’t be empty.", envvar);
- ASSERT_MSG(user_dir[0] == '/', "User directory {} must be absolute.", envvar);
-
- return user_dir;
-}
-#endif
-
-std::string GetSysDirectory() {
- std::string sysDir;
-
-#if defined(__APPLE__)
- sysDir = GetBundleDirectory();
- sysDir += DIR_SEP;
- sysDir += SYSDATA_DIR;
-#else
- sysDir = SYSDATA_DIR;
-#endif
- sysDir += DIR_SEP;
-
- LOG_DEBUG(Common_Filesystem, "Setting to {}:", sysDir);
- return sysDir;
-}
-
-const std::string& GetUserPath(UserPath path, const std::string& new_path) {
- static std::unordered_map<UserPath, std::string> paths;
- auto& user_path = paths[UserPath::UserDir];
-
- // Set up all paths and files on the first run
- if (user_path.empty()) {
-#ifdef _WIN32
- user_path = GetExeDirectory() + DIR_SEP USERDATA_DIR DIR_SEP;
- if (!IsDirectory(user_path)) {
- user_path = AppDataRoamingDirectory() + DIR_SEP EMU_DATA_DIR DIR_SEP;
- } else {
- LOG_INFO(Common_Filesystem, "Using the local user directory");
- }
-
- paths.emplace(UserPath::ConfigDir, user_path + CONFIG_DIR DIR_SEP);
- paths.emplace(UserPath::CacheDir, user_path + CACHE_DIR DIR_SEP);
-#else
- if (Exists(ROOT_DIR DIR_SEP USERDATA_DIR)) {
- user_path = ROOT_DIR DIR_SEP USERDATA_DIR DIR_SEP;
- paths.emplace(UserPath::ConfigDir, user_path + CONFIG_DIR DIR_SEP);
- paths.emplace(UserPath::CacheDir, user_path + CACHE_DIR DIR_SEP);
- } else {
- std::string data_dir = GetUserDirectory("XDG_DATA_HOME");
- std::string config_dir = GetUserDirectory("XDG_CONFIG_HOME");
- std::string cache_dir = GetUserDirectory("XDG_CACHE_HOME");
-
- user_path = data_dir + DIR_SEP EMU_DATA_DIR DIR_SEP;
- paths.emplace(UserPath::ConfigDir, config_dir + DIR_SEP EMU_DATA_DIR DIR_SEP);
- paths.emplace(UserPath::CacheDir, cache_dir + DIR_SEP EMU_DATA_DIR DIR_SEP);
- }
-#endif
- paths.emplace(UserPath::SDMCDir, user_path + SDMC_DIR DIR_SEP);
- paths.emplace(UserPath::NANDDir, user_path + NAND_DIR DIR_SEP);
- paths.emplace(UserPath::LoadDir, user_path + LOAD_DIR DIR_SEP);
- paths.emplace(UserPath::DumpDir, user_path + DUMP_DIR DIR_SEP);
- paths.emplace(UserPath::ScreenshotsDir, user_path + SCREENSHOTS_DIR DIR_SEP);
- paths.emplace(UserPath::ShaderDir, user_path + SHADER_DIR DIR_SEP);
- paths.emplace(UserPath::SysDataDir, user_path + SYSDATA_DIR DIR_SEP);
- paths.emplace(UserPath::KeysDir, user_path + KEYS_DIR DIR_SEP);
- // TODO: Put the logs in a better location for each OS
- paths.emplace(UserPath::LogDir, user_path + LOG_DIR DIR_SEP);
- }
-
- if (!new_path.empty()) {
- if (!IsDirectory(new_path)) {
- LOG_ERROR(Common_Filesystem, "Invalid path specified {}", new_path);
- return paths[path];
- } else {
- paths[path] = new_path;
- }
-
- switch (path) {
- case UserPath::RootDir:
- user_path = paths[UserPath::RootDir] + DIR_SEP;
- break;
- case UserPath::UserDir:
- user_path = paths[UserPath::RootDir] + DIR_SEP;
- paths[UserPath::ConfigDir] = user_path + CONFIG_DIR DIR_SEP;
- paths[UserPath::CacheDir] = user_path + CACHE_DIR DIR_SEP;
- paths[UserPath::SDMCDir] = user_path + SDMC_DIR DIR_SEP;
- paths[UserPath::NANDDir] = user_path + NAND_DIR DIR_SEP;
- break;
- default:
- break;
- }
- }
-
- return paths[path];
-}
-
-std::string GetHactoolConfigurationPath() {
-#ifdef _WIN32
- PWSTR pw_local_path = nullptr;
- if (SHGetKnownFolderPath(FOLDERID_Profile, 0, nullptr, &pw_local_path) != S_OK)
- return "";
- std::string local_path = Common::UTF16ToUTF8(pw_local_path);
- CoTaskMemFree(pw_local_path);
- return local_path + "\\.switch";
-#else
- return GetHomeDirectory() + "/.switch";
-#endif
-}
-
-std::string GetNANDRegistrationDir(bool system) {
- if (system)
- return GetUserPath(UserPath::NANDDir) + "system/Contents/registered/";
- return GetUserPath(UserPath::NANDDir) + "user/Contents/registered/";
-}
-
-std::size_t WriteStringToFile(bool text_file, const std::string& filename, std::string_view str) {
- return IOFile(filename, text_file ? "w" : "wb").WriteString(str);
-}
-
-std::size_t ReadFileToString(bool text_file, const std::string& filename, std::string& str) {
- IOFile file(filename, text_file ? "r" : "rb");
-
- if (!file.IsOpen())
- return 0;
-
- str.resize(static_cast<u32>(file.GetSize()));
- return file.ReadArray(&str[0], str.size());
-}
-
-void SplitFilename83(const std::string& filename, std::array<char, 9>& short_name,
- std::array<char, 4>& extension) {
- static constexpr std::string_view forbidden_characters = ".\"/\\[]:;=, ";
-
- // On a FAT32 partition, 8.3 names are stored as a 11 bytes array, filled with spaces.
- short_name = {{' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', '\0'}};
- extension = {{' ', ' ', ' ', '\0'}};
-
- auto point = filename.rfind('.');
- if (point == filename.size() - 1) {
- point = filename.rfind('.', point);
- }
-
- // Get short name.
- int j = 0;
- for (char letter : filename.substr(0, point)) {
- if (forbidden_characters.find(letter, 0) != std::string::npos) {
- continue;
- }
- if (j == 8) {
- // TODO(Link Mauve): also do that for filenames containing a space.
- // TODO(Link Mauve): handle multiple files having the same short name.
- short_name[6] = '~';
- short_name[7] = '1';
- break;
- }
- short_name[j++] = static_cast<char>(std::toupper(letter));
- }
-
- // Get extension.
- if (point != std::string::npos) {
- j = 0;
- for (char letter : filename.substr(point + 1, 3)) {
- extension[j++] = static_cast<char>(std::toupper(letter));
- }
- }
-}
-
-std::vector<std::string> SplitPathComponents(std::string_view filename) {
- std::string copy(filename);
- std::replace(copy.begin(), copy.end(), '\\', '/');
- std::vector<std::string> out;
-
- std::stringstream stream(copy);
- std::string item;
- while (std::getline(stream, item, '/')) {
- out.push_back(std::move(item));
- }
-
- return out;
-}
-
-std::string_view GetParentPath(std::string_view path) {
- const auto name_bck_index = path.rfind('\\');
- const auto name_fwd_index = path.rfind('/');
- std::size_t name_index;
-
- if (name_bck_index == std::string_view::npos || name_fwd_index == std::string_view::npos) {
- name_index = std::min(name_bck_index, name_fwd_index);
- } else {
- name_index = std::max(name_bck_index, name_fwd_index);
- }
-
- return path.substr(0, name_index);
-}
-
-std::string_view GetPathWithoutTop(std::string_view path) {
- if (path.empty()) {
- return path;
- }
-
- while (path[0] == '\\' || path[0] == '/') {
- path.remove_prefix(1);
- if (path.empty()) {
- return path;
- }
- }
-
- const auto name_bck_index = path.find('\\');
- const auto name_fwd_index = path.find('/');
- return path.substr(std::min(name_bck_index, name_fwd_index) + 1);
-}
-
-std::string_view GetFilename(std::string_view path) {
- const auto name_index = path.find_last_of("\\/");
-
- if (name_index == std::string_view::npos) {
- return {};
- }
-
- return path.substr(name_index + 1);
-}
-
-std::string_view GetExtensionFromFilename(std::string_view name) {
- const std::size_t index = name.rfind('.');
-
- if (index == std::string_view::npos) {
- return {};
- }
-
- return name.substr(index + 1);
-}
-
-std::string_view RemoveTrailingSlash(std::string_view path) {
- if (path.empty()) {
- return path;
- }
-
- if (path.back() == '\\' || path.back() == '/') {
- path.remove_suffix(1);
- return path;
- }
-
- return path;
-}
-
-std::string SanitizePath(std::string_view path_, DirectorySeparator directory_separator) {
- std::string path(path_);
- char type1 = directory_separator == DirectorySeparator::BackwardSlash ? '/' : '\\';
- char type2 = directory_separator == DirectorySeparator::BackwardSlash ? '\\' : '/';
-
- if (directory_separator == DirectorySeparator::PlatformDefault) {
-#ifdef _WIN32
- type1 = '/';
- type2 = '\\';
-#endif
- }
-
- std::replace(path.begin(), path.end(), type1, type2);
-
- auto start = path.begin();
-#ifdef _WIN32
- // allow network paths which start with a double backslash (e.g. \\server\share)
- if (start != path.end())
- ++start;
-#endif
- path.erase(std::unique(start, path.end(),
- [type2](char c1, char c2) { return c1 == type2 && c2 == type2; }),
- path.end());
- return std::string(RemoveTrailingSlash(path));
-}
-
-IOFile::IOFile() = default;
-
-IOFile::IOFile(const std::string& filename, const char openmode[], int flags) {
- void(Open(filename, openmode, flags));
-}
-
-IOFile::~IOFile() {
- Close();
-}
-
-IOFile::IOFile(IOFile&& other) noexcept {
- Swap(other);
-}
-
-IOFile& IOFile::operator=(IOFile&& other) noexcept {
- Swap(other);
- return *this;
-}
-
-void IOFile::Swap(IOFile& other) noexcept {
- std::swap(m_file, other.m_file);
-}
-
-bool IOFile::Open(const std::string& filename, const char openmode[], int flags) {
- Close();
- bool m_good;
-#ifdef _WIN32
- if (flags != 0) {
- m_file = _wfsopen(Common::UTF8ToUTF16W(filename).c_str(),
- Common::UTF8ToUTF16W(openmode).c_str(), flags);
- m_good = m_file != nullptr;
- } else {
- m_good = _wfopen_s(&m_file, Common::UTF8ToUTF16W(filename).c_str(),
- Common::UTF8ToUTF16W(openmode).c_str()) == 0;
- }
-#else
- m_file = std::fopen(filename.c_str(), openmode);
- m_good = m_file != nullptr;
-#endif
-
- return m_good;
-}
-
-bool IOFile::Close() {
- if (!IsOpen() || 0 != std::fclose(m_file)) {
- return false;
- }
-
- m_file = nullptr;
- return true;
-}
-
-u64 IOFile::GetSize() const {
- if (IsOpen()) {
- return FS::GetSize(m_file);
- }
- return 0;
-}
-
-bool IOFile::Seek(s64 off, int origin) const {
- return IsOpen() && 0 == fseeko(m_file, off, origin);
-}
-
-u64 IOFile::Tell() const {
- if (IsOpen()) {
- return ftello(m_file);
- }
- return std::numeric_limits<u64>::max();
-}
-
-bool IOFile::Flush() {
- return IsOpen() && 0 == std::fflush(m_file);
-}
-
-std::size_t IOFile::ReadImpl(void* data, std::size_t length, std::size_t data_size) const {
- if (!IsOpen()) {
- return std::numeric_limits<std::size_t>::max();
- }
-
- if (length == 0) {
- return 0;
- }
-
- DEBUG_ASSERT(data != nullptr);
-
- return std::fread(data, data_size, length, m_file);
-}
-
-std::size_t IOFile::WriteImpl(const void* data, std::size_t length, std::size_t data_size) {
- if (!IsOpen()) {
- return std::numeric_limits<std::size_t>::max();
- }
-
- if (length == 0) {
- return 0;
- }
-
- DEBUG_ASSERT(data != nullptr);
-
- return std::fwrite(data, data_size, length, m_file);
-}
-
-bool IOFile::Resize(u64 size) {
- return IsOpen() && 0 ==
-#ifdef _WIN32
- // ector: _chsize sucks, not 64-bit safe
- // F|RES: changed to _chsize_s. i think it is 64-bit safe
- _chsize_s(_fileno(m_file), size)
-#else
- // TODO: handle 64bit and growing
- ftruncate(fileno(m_file), size)
-#endif
- ;
-}
-
-} // namespace Common::FS
--
cgit v1.2.3-70-g09d2