suyu/src/common/file_util.cpp

1002 lines
30 KiB
C++
Raw Normal View History

2014-12-17 06:38:14 +01:00
// 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 <memory>
#include <sstream>
#include <unordered_map>
2015-05-06 09:06:12 +02:00
#include "common/assert.h"
#include "common/common_funcs.h"
#include "common/common_paths.h"
#include "common/file_util.h"
2015-05-06 09:06:12 +02:00
#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__)
2016-12-13 18:58:50 +01:00
// 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>
2016-12-13 18:58:50 +01:00
#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 FileUtil {
// Remove any ending forward slashes from directory paths
// Modifies argument.
static void StripTailDirSlashes(std::string& fname) {
if (fname.length() > 1) {
std::size_t i = fname.length();
while (i > 0 && fname[i - 1] == DIR_SEP_CHR)
--i;
fname.resize(i);
2014-04-02 00:20:08 +02:00
}
return;
}
// Returns true if file filename exists
bool Exists(const std::string& filename) {
struct stat file_info;
2014-04-02 00:20:08 +02:00
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;
2016-03-31 12:58:37 +02:00
int result = _wstat64(Common::UTF8ToUTF16W(copy).c_str(), &file_info);
#else
int result = stat(copy.c_str(), &file_info);
#endif
2014-04-02 00:20:08 +02:00
return (result == 0);
}
// Returns true if filename is a directory
bool IsDirectory(const std::string& filename) {
struct stat file_info;
2014-04-02 00:20:08 +02:00
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;
2016-03-31 12:58:37 +02:00
int result = _wstat64(Common::UTF8ToUTF16W(copy).c_str(), &file_info);
#else
int result = stat(copy.c_str(), &file_info);
#endif
2014-04-02 00:20:08 +02:00
if (result < 0) {
2018-07-02 18:13:26 +02:00
LOG_DEBUG(Common_Filesystem, "stat failed on {}: {}", filename, GetLastErrorMsg());
2014-04-02 00:20:08 +02:00
return false;
}
2014-04-02 00:20:08 +02:00
return S_ISDIR(file_info.st_mode);
}
// Deletes a given filename, return true on success
// Doesn't supports deleting a directory
bool Delete(const std::string& filename) {
2018-07-02 18:13:26 +02:00
LOG_TRACE(Common_Filesystem, "file {}", filename);
// Return true because we care about the file no
2014-04-02 00:20:08 +02:00
// being there, not the actual delete.
if (!Exists(filename)) {
2018-07-02 18:13:26 +02:00
LOG_DEBUG(Common_Filesystem, "{} does not exist", filename);
2014-04-02 00:20:08 +02:00
return true;
}
2014-04-02 00:20:08 +02:00
// We can't delete a directory
if (IsDirectory(filename)) {
2018-07-02 18:13:26 +02:00
LOG_ERROR(Common_Filesystem, "Failed: {} is a directory", filename);
2014-04-02 00:20:08 +02:00
return false;
}
#ifdef _WIN32
if (!DeleteFileW(Common::UTF8ToUTF16W(filename).c_str())) {
2018-07-02 18:13:26 +02:00
LOG_ERROR(Common_Filesystem, "DeleteFile failed on {}: {}", filename, GetLastErrorMsg());
2014-04-02 00:20:08 +02:00
return false;
}
#else
2014-04-02 00:20:08 +02:00
if (unlink(filename.c_str()) == -1) {
2018-07-02 18:13:26 +02:00
LOG_ERROR(Common_Filesystem, "unlink failed on {}: {}", filename, GetLastErrorMsg());
2014-04-02 00:20:08 +02:00
return false;
}
#endif
2014-04-02 00:20:08 +02:00
return true;
}
// Returns true if successful, or path already exists.
bool CreateDir(const std::string& path) {
2018-07-02 18:13:26 +02:00
LOG_TRACE(Common_Filesystem, "directory {}", path);
#ifdef _WIN32
2016-03-31 12:58:37 +02:00
if (::CreateDirectoryW(Common::UTF8ToUTF16W(path).c_str(), nullptr))
2014-04-02 00:20:08 +02:00
return true;
DWORD error = GetLastError();
if (error == ERROR_ALREADY_EXISTS) {
2018-07-02 18:13:26 +02:00
LOG_DEBUG(Common_Filesystem, "CreateDirectory failed on {}: already exists", path);
2014-04-02 00:20:08 +02:00
return true;
}
2018-07-02 18:13:26 +02:00
LOG_ERROR(Common_Filesystem, "CreateDirectory failed on {}: {}", path, error);
2014-04-02 00:20:08 +02:00
return false;
#else
2014-04-02 00:20:08 +02:00
if (mkdir(path.c_str(), 0755) == 0)
return true;
2014-04-02 00:20:08 +02:00
int err = errno;
if (err == EEXIST) {
2018-07-02 18:13:26 +02:00
LOG_DEBUG(Common_Filesystem, "mkdir failed on {}: already exists", path);
2014-04-02 00:20:08 +02:00
return true;
}
2018-07-02 18:13:26 +02:00
LOG_ERROR(Common_Filesystem, "mkdir failed on {}: {}", path, strerror(err));
2014-04-02 00:20:08 +02:00
return false;
#endif
}
// Creates the full path of fullPath returns true on success
bool CreateFullPath(const std::string& fullPath) {
2014-04-02 00:20:08 +02:00
int panicCounter = 100;
2018-07-02 18:13:26 +02:00
LOG_TRACE(Common_Filesystem, "path {}", fullPath);
2016-03-31 14:29:39 +02:00
if (FileUtil::Exists(fullPath)) {
2018-07-02 18:13:26 +02:00
LOG_DEBUG(Common_Filesystem, "path exists {}", fullPath);
2014-04-02 00:20:08 +02:00
return true;
}
std::size_t position = 0;
while (true) {
2014-04-02 00:20:08 +02:00
// Find next sub path
position = fullPath.find(DIR_SEP_CHR, position);
2014-04-02 00:20:08 +02:00
// we're done, yay!
if (position == fullPath.npos)
return true;
2014-04-02 00:20:08 +02:00
// Include the '/' so the first call is CreateDir("/") rather than CreateDir("")
std::string const subPath(fullPath.substr(0, position + 1));
if (!FileUtil::IsDirectory(subPath) && !FileUtil::CreateDir(subPath)) {
2018-07-02 18:13:26 +02:00
LOG_ERROR(Common, "CreateFullPath: directory creation failed");
return false;
}
2014-04-02 00:20:08 +02:00
// A safety check
panicCounter--;
if (panicCounter <= 0) {
2018-07-02 18:13:26 +02:00
LOG_ERROR(Common, "CreateFullPath: directory structure is too deep");
2014-04-02 00:20:08 +02:00
return false;
}
position++;
}
}
// Deletes a directory filename, returns true on success
bool DeleteDir(const std::string& filename) {
2018-07-02 18:13:26 +02:00
LOG_TRACE(Common_Filesystem, "directory {}", filename);
2014-04-02 00:20:08 +02:00
// check if a directory
if (!FileUtil::IsDirectory(filename)) {
2018-07-02 18:13:26 +02:00
LOG_ERROR(Common_Filesystem, "Not a directory {}", filename);
2014-04-02 00:20:08 +02:00
return false;
}
#ifdef _WIN32
2016-03-31 12:58:37 +02:00
if (::RemoveDirectoryW(Common::UTF8ToUTF16W(filename).c_str()))
2014-04-02 00:20:08 +02:00
return true;
#else
2014-04-02 00:20:08 +02:00
if (rmdir(filename.c_str()) == 0)
return true;
#endif
2018-07-02 18:13:26 +02:00
LOG_ERROR(Common_Filesystem, "failed {}: {}", filename, GetLastErrorMsg());
2014-04-02 00:20:08 +02:00
return false;
}
// renames file srcFilename to destFilename, returns true on success
bool Rename(const std::string& srcFilename, const std::string& destFilename) {
2018-07-02 18:13:26 +02:00
LOG_TRACE(Common_Filesystem, "{} --> {}", srcFilename, destFilename);
2016-03-31 12:58:37 +02:00
#ifdef _WIN32
if (_wrename(Common::UTF8ToUTF16W(srcFilename).c_str(),
Common::UTF8ToUTF16W(destFilename).c_str()) == 0)
2016-03-31 12:58:37 +02:00
return true;
#else
2014-04-02 00:20:08 +02:00
if (rename(srcFilename.c_str(), destFilename.c_str()) == 0)
return true;
2016-03-31 12:58:37 +02:00
#endif
2018-07-02 18:13:26 +02:00
LOG_ERROR(Common_Filesystem, "failed {} --> {}: {}", srcFilename, destFilename,
2018-07-02 18:20:50 +02:00
GetLastErrorMsg());
2014-04-02 00:20:08 +02:00
return false;
}
// copies file srcFilename to destFilename, returns true on success
bool Copy(const std::string& srcFilename, const std::string& destFilename) {
2018-07-02 18:13:26 +02:00
LOG_TRACE(Common_Filesystem, "{} --> {}", srcFilename, destFilename);
#ifdef _WIN32
if (CopyFileW(Common::UTF8ToUTF16W(srcFilename).c_str(),
Common::UTF8ToUTF16W(destFilename).c_str(), FALSE))
2014-04-02 00:20:08 +02:00
return true;
2018-07-02 18:13:26 +02:00
LOG_ERROR(Common_Filesystem, "failed {} --> {}: {}", srcFilename, destFilename,
2018-07-02 18:20:50 +02:00
GetLastErrorMsg());
2014-04-02 00:20:08 +02:00
return false;
#else
using CFilePointer = std::unique_ptr<FILE, decltype(&std::fclose)>;
2014-04-02 00:20:08 +02:00
// Open input file
CFilePointer input{fopen(srcFilename.c_str(), "rb"), std::fclose};
if (!input) {
2018-07-02 18:13:26 +02:00
LOG_ERROR(Common_Filesystem, "opening input failed {} --> {}: {}", srcFilename,
2018-07-02 18:20:50 +02:00
destFilename, GetLastErrorMsg());
2014-04-02 00:20:08 +02:00
return false;
}
// open output file
CFilePointer output{fopen(destFilename.c_str(), "wb"), std::fclose};
if (!output) {
2018-07-02 18:13:26 +02:00
LOG_ERROR(Common_Filesystem, "opening output failed {} --> {}: {}", srcFilename,
2018-07-02 18:20:50 +02:00
destFilename, GetLastErrorMsg());
2014-04-02 00:20:08 +02:00
return false;
}
// copy loop
std::array<char, 1024> buffer;
while (!feof(input.get())) {
2014-04-02 00:20:08 +02:00
// read input
std::size_t rnum = fread(buffer.data(), sizeof(char), buffer.size(), input.get());
if (rnum != buffer.size()) {
if (ferror(input.get()) != 0) {
2018-07-02 18:13:26 +02:00
LOG_ERROR(Common_Filesystem, "failed reading from source, {} --> {}: {}",
2018-07-02 18:20:50 +02:00
srcFilename, destFilename, GetLastErrorMsg());
return false;
2014-04-02 00:20:08 +02:00
}
}
// write output
std::size_t wnum = fwrite(buffer.data(), sizeof(char), rnum, output.get());
if (wnum != rnum) {
2018-07-02 18:13:26 +02:00
LOG_ERROR(Common_Filesystem, "failed writing to output, {} --> {}: {}", srcFilename,
2018-07-02 18:20:50 +02:00
destFilename, GetLastErrorMsg());
return false;
2014-04-02 00:20:08 +02:00
}
}
2014-04-02 00:20:08 +02:00
return true;
#endif
}
// Returns the size of filename (64bit)
u64 GetSize(const std::string& filename) {
if (!Exists(filename)) {
2018-07-02 18:13:26 +02:00
LOG_ERROR(Common_Filesystem, "failed {}: No such file", filename);
2014-04-02 00:20:08 +02:00
return 0;
}
if (IsDirectory(filename)) {
2018-07-02 18:13:26 +02:00
LOG_ERROR(Common_Filesystem, "failed {}: is a directory", filename);
2014-04-02 00:20:08 +02:00
return 0;
}
struct stat buf;
#ifdef _WIN32
2016-03-31 12:58:37 +02:00
if (_wstat64(Common::UTF8ToUTF16W(filename).c_str(), &buf) == 0)
#else
if (stat(filename.c_str(), &buf) == 0)
#endif
2014-04-02 00:20:08 +02:00
{
2018-07-02 18:13:26 +02:00
LOG_TRACE(Common_Filesystem, "{}: {}", filename, buf.st_size);
2014-04-02 00:20:08 +02:00
return buf.st_size;
}
2018-07-02 18:13:26 +02:00
LOG_ERROR(Common_Filesystem, "Stat failed {}: {}", filename, GetLastErrorMsg());
2014-04-02 00:20:08 +02:00
return 0;
}
// Overloaded GetSize, accepts file descriptor
u64 GetSize(const int fd) {
struct stat buf;
if (fstat(fd, &buf) != 0) {
2018-07-02 18:13:26 +02:00
LOG_ERROR(Common_Filesystem, "GetSize: stat failed {}: {}", fd, GetLastErrorMsg());
2014-04-02 00:20:08 +02:00
return 0;
}
return buf.st_size;
}
// Overloaded GetSize, accepts FILE*
u64 GetSize(FILE* f) {
2014-04-02 00:20:08 +02:00
// can't use off_t here because it can be 32-bit
u64 pos = ftello(f);
if (fseeko(f, 0, SEEK_END) != 0) {
2018-07-02 18:20:50 +02:00
LOG_ERROR(Common_Filesystem, "GetSize: seek failed {}: {}", fmt::ptr(f), GetLastErrorMsg());
2014-04-02 00:20:08 +02:00
return 0;
}
u64 size = ftello(f);
if ((size != pos) && (fseeko(f, pos, SEEK_SET) != 0)) {
2018-07-02 18:20:50 +02:00
LOG_ERROR(Common_Filesystem, "GetSize: seek failed {}: {}", fmt::ptr(f), GetLastErrorMsg());
2014-04-02 00:20:08 +02:00
return 0;
}
return size;
}
// creates an empty file filename, returns true on success
bool CreateEmptyFile(const std::string& filename) {
2018-07-02 18:13:26 +02:00
LOG_TRACE(Common_Filesystem, "{}", filename);
if (!FileUtil::IOFile(filename, "wb").IsOpen()) {
2018-07-02 18:13:26 +02:00
LOG_ERROR(Common_Filesystem, "failed {}: {}", filename, GetLastErrorMsg());
2014-04-02 00:20:08 +02:00
return false;
}
2014-04-02 00:20:08 +02:00
return true;
}
bool ForeachDirectoryEntry(u64* num_entries_out, const std::string& directory,
DirectoryEntryCallable callback) {
2018-07-02 18:13:26 +02:00
LOG_TRACE(Common_Filesystem, "directory {}", directory);
2014-04-02 00:20:08 +02:00
// How many files + directories we found
u64 found_entries = 0;
// Save the status of callback function
bool callback_error = false;
#ifdef _WIN32
2014-04-02 00:20:08 +02:00
// Find the first file in the directory.
2016-03-31 12:58:37 +02:00
WIN32_FIND_DATAW ffd;
2014-04-02 00:20:08 +02:00
2016-03-31 12:58:37 +02:00
HANDLE handle_find = FindFirstFileW(Common::UTF8ToUTF16W(directory + "\\*").c_str(), &ffd);
if (handle_find == INVALID_HANDLE_VALUE) {
FindClose(handle_find);
return false;
2014-04-02 00:20:08 +02:00
}
// windows loop
do {
2016-03-31 12:58:37 +02:00
const std::string virtual_name(Common::UTF16ToUTF8(ffd.cFileName));
#else
DIR* dirp = opendir(directory.c_str());
2014-04-02 00:20:08 +02:00
if (!dirp)
return false;
2014-04-02 00:20:08 +02:00
// non windows loop
while (struct dirent* result = readdir(dirp)) {
const std::string virtual_name(result->d_name);
#endif
if (virtual_name == "." || virtual_name == "..")
2014-04-02 00:20:08 +02:00
continue;
u64 ret_entries = 0;
if (!callback(&ret_entries, directory, virtual_name)) {
callback_error = true;
break;
}
found_entries += ret_entries;
#ifdef _WIN32
2016-03-31 12:58:37 +02:00
} while (FindNextFileW(handle_find, &ffd) != 0);
FindClose(handle_find);
#else
2014-04-02 00:20:08 +02:00
}
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;
};
2014-04-02 00:20:08 +02:00
u64 num_entries;
return ForeachDirectoryEntry(&num_entries, directory, callback) ? num_entries : 0;
}
2014-04-02 00:20:08 +02:00
bool DeleteDirRecursively(const std::string& directory, unsigned int recursion) {
const auto callback = [recursion](u64* num_entries_out, const std::string& directory,
const std::string& virtual_name) -> bool {
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
FileUtil::DeleteDir(directory);
2014-04-02 00:20:08 +02:00
return true;
}
// Create directory and copy contents (does not overwrite existing files)
void CopyDir(const std::string& source_path, const std::string& dest_path) {
#ifndef _WIN32
if (source_path == dest_path)
return;
if (!FileUtil::Exists(source_path))
return;
if (!FileUtil::Exists(dest_path))
FileUtil::CreateFullPath(dest_path);
DIR* dirp = opendir(source_path.c_str());
if (!dirp)
return;
2014-04-02 00:20:08 +02:00
while (struct dirent* result = readdir(dirp)) {
2014-04-02 00:20:08 +02:00
const std::string virtualName(result->d_name);
// check for "." and ".."
if (((virtualName[0] == '.') && (virtualName[1] == '\0')) ||
((virtualName[0] == '.') && (virtualName[1] == '.') && (virtualName[2] == '\0')))
2014-04-02 00:20:08 +02:00
continue;
std::string source, dest;
source = source_path + virtualName;
dest = dest_path + virtualName;
if (IsDirectory(source)) {
2014-04-02 00:20:08 +02:00
source += '/';
dest += '/';
if (!FileUtil::Exists(dest))
FileUtil::CreateFullPath(dest);
2014-04-02 00:20:08 +02:00
CopyDir(source, dest);
} else if (!FileUtil::Exists(dest))
FileUtil::Copy(source, dest);
2014-04-02 00:20:08 +02:00
}
closedir(dirp);
#endif
}
// Returns the current directory
std::string GetCurrentDir() {
// Get the current working directory (getcwd uses malloc)
2016-03-31 13:21:03 +02:00
#ifdef _WIN32
wchar_t* dir;
2016-03-31 13:21:03 +02:00
if (!(dir = _wgetcwd(nullptr, 0))) {
#else
char* dir;
if (!(dir = getcwd(nullptr, 0))) {
2016-03-31 13:21:03 +02:00
#endif
2018-07-02 18:13:26 +02:00
LOG_ERROR(Common_Filesystem, "GetCurrentDirectory failed: {}", GetLastErrorMsg());
2014-12-03 19:57:57 +01:00
return nullptr;
2014-04-02 00:20:08 +02:00
}
2016-03-31 13:21:03 +02:00
#ifdef _WIN32
std::string strDir = Common::UTF16ToUTF8(dir);
#else
2014-04-02 00:20:08 +02:00
std::string strDir = dir;
2016-03-31 13:21:03 +02:00
#endif
2014-04-02 00:20:08 +02:00
free(dir);
return strDir;
}
// Sets the current directory to the given directory
bool SetCurrentDir(const std::string& directory) {
2016-03-31 13:21:03 +02:00
#ifdef _WIN32
return _wchdir(Common::UTF8ToUTF16W(directory).c_str()) == 0;
#else
return chdir(directory.c_str()) == 0;
2016-03-31 13:21:03 +02:00
#endif
}
#if defined(__APPLE__)
std::string GetBundleDirectory() {
2014-04-02 00:20:08 +02:00
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);
2014-04-02 00:20:08 +02:00
return AppBundlePath;
}
#endif
#ifdef _WIN32
const std::string& GetExeDirectory() {
static std::string exe_path;
if (exe_path.empty()) {
2016-03-31 13:21:03 +02:00
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('\\'));
2014-04-02 00:20:08 +02:00
}
return exe_path;
}
2016-11-24 16:42:31 +01:00
std::string AppDataRoamingDirectory() {
2016-11-17 12:29:57 +01:00
PWSTR pw_local_path = nullptr;
// Only supported by Windows Vista or later
2016-11-24 16:42:31 +01:00
SHGetKnownFolderPath(FOLDERID_RoamingAppData, 0, nullptr, &pw_local_path);
2016-11-17 12:29:57 +01:00
std::string local_path = Common::UTF16ToUTF8(pw_local_path);
CoTaskMemFree(pw_local_path);
return local_path;
}
#else
/**
* @return The users 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 isnt defined, and the current user cant 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 {} mustnt be empty.", envvar);
ASSERT_MSG(user_dir[0] == '/', "User directory {} must be absolute.", envvar);
return user_dir;
}
#endif
std::string GetSysDirectory() {
2014-04-02 00:20:08 +02:00
std::string sysDir;
#if defined(__APPLE__)
2014-04-02 00:20:08 +02:00
sysDir = GetBundleDirectory();
sysDir += DIR_SEP;
sysDir += SYSDATA_DIR;
#else
2014-04-02 00:20:08 +02:00
sysDir = SYSDATA_DIR;
#endif
2014-04-02 00:20:08 +02:00
sysDir += DIR_SEP;
2018-07-02 18:13:26 +02:00
LOG_DEBUG(Common_Filesystem, "Setting to {}:", sysDir);
2014-04-02 00:20:08 +02:00
return sysDir;
}
2018-07-06 15:47:06 +02:00
// Returns a string with a yuzu data dir or file in the user's home
// directory. To be used in "multi-user" mode (that is, installed).
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];
2014-04-02 00:20:08 +02:00
// 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 (!FileUtil::IsDirectory(user_path)) {
user_path = AppDataRoamingDirectory() + DIR_SEP EMU_DATA_DIR DIR_SEP;
} else {
2018-07-02 18:13:26 +02:00
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 (FileUtil::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);
2018-09-20 03:53:04 +02:00
paths.emplace(UserPath::LoadDir, user_path + LOAD_DIR DIR_SEP);
paths.emplace(UserPath::DumpDir, user_path + DUMP_DIR DIR_SEP);
2019-01-11 05:46:49 +01:00
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);
2018-07-02 19:10:41 +02:00
// TODO: Put the logs in a better location for each OS
paths.emplace(UserPath::LogDir, user_path + LOG_DIR DIR_SEP);
2014-04-02 00:20:08 +02:00
}
if (!new_path.empty()) {
if (!FileUtil::IsDirectory(new_path)) {
LOG_ERROR(Common_Filesystem, "Invalid path specified {}", new_path);
return paths[path];
} else {
paths[path] = new_path;
2014-04-02 00:20:08 +02:00
}
switch (path) {
case UserPath::RootDir:
user_path = paths[UserPath::RootDir] + DIR_SEP;
2014-04-02 00:20:08 +02:00
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;
2014-04-02 00:20:08 +02:00
break;
}
}
return paths[path];
}
2018-07-28 05:55:23 +02:00
std::string GetHactoolConfigurationPath() {
#ifdef _WIN32
PWSTR pw_local_path = nullptr;
if (SHGetKnownFolderPath(FOLDERID_Profile, 0, nullptr, &pw_local_path) != S_OK)
2018-07-28 05:55:23 +02:00
return "";
std::string local_path = Common::UTF16ToUTF8(pw_local_path);
CoTaskMemFree(pw_local_path);
2018-07-28 05:55:23 +02:00
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& str, const char* filename) {
return FileUtil::IOFile(filename, text_file ? "w" : "wb").WriteBytes(str.data(), str.size());
}
std::size_t ReadFileToString(bool text_file, const char* filename, std::string& str) {
IOFile file(filename, text_file ? "r" : "rb");
if (!file.IsOpen())
return 0;
str.resize(static_cast<u32>(file.GetSize()));
2014-04-02 00:20:08 +02:00
return file.ReadArray(&str[0], str.size());
}
/**
* Splits the filename into 8.3 format
* Loosely implemented following https://en.wikipedia.org/wiki/8.3_filename
* @param filename The normal filename to use
* @param short_name A 9-char array in which the short name will be written
* @param extension A 4-char array in which the extension will be written
*/
void SplitFilename83(const std::string& filename, std::array<char, 9>& short_name,
std::array<char, 4>& extension) {
const std::string forbidden_characters = ".\"/\\[]:;=, ";
// On a FAT32 partition, 8.3 names are stored as a 11 bytes array, filled with spaces.
short_name = {{' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', '\0'}};
extension = {{' ', ' ', ' ', '\0'}};
std::string::size_type 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++] = toupper(letter);
}
// Get extension.
if (point != std::string::npos) {
j = 0;
for (char letter : filename.substr(point + 1, 3))
extension[j++] = 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);
path.erase(std::unique(path.begin(), path.end(),
[type2](char c1, char c2) { return c1 == type2 && c2 == type2; }),
path.end());
return std::string(RemoveTrailingSlash(path));
}
IOFile::IOFile() {}
2018-07-02 19:10:41 +02:00
IOFile::IOFile(const std::string& filename, const char openmode[], int flags) {
Open(filename, openmode, flags);
}
IOFile::~IOFile() {
2014-04-02 00:20:08 +02:00
Close();
}
IOFile::IOFile(IOFile&& other) noexcept {
2014-04-02 00:20:08 +02:00
Swap(other);
}
IOFile& IOFile::operator=(IOFile&& other) noexcept {
2014-04-02 00:20:08 +02:00
Swap(other);
return *this;
}
void IOFile::Swap(IOFile& other) noexcept {
2014-04-02 00:20:08 +02:00
std::swap(m_file, other.m_file);
}
2018-07-02 19:10:41 +02:00
bool IOFile::Open(const std::string& filename, const char openmode[], int flags) {
2014-04-02 00:20:08 +02:00
Close();
#ifdef _WIN32
2018-07-02 19:10:41 +02:00
if (flags != 0) {
m_file = _wfsopen(Common::UTF8ToUTF16W(filename).c_str(),
Common::UTF8ToUTF16W(openmode).c_str(), flags);
} else {
_wfopen_s(&m_file, Common::UTF8ToUTF16W(filename).c_str(),
Common::UTF8ToUTF16W(openmode).c_str());
}
#else
2014-04-02 00:20:08 +02:00
m_file = fopen(filename.c_str(), openmode);
#endif
return IsOpen();
}
bool IOFile::Close() {
2014-04-02 00:20:08 +02:00
if (!IsOpen() || 0 != std::fclose(m_file))
return false;
2014-12-03 19:57:57 +01:00
m_file = nullptr;
return true;
}
u64 IOFile::GetSize() const {
2014-04-02 00:20:08 +02:00
if (IsOpen())
return FileUtil::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 {
2014-04-02 00:20:08 +02:00
if (IsOpen())
return ftello(m_file);
return -1;
}
bool IOFile::Flush() {
return IsOpen() && 0 == std::fflush(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 FileUtil