yuzu/src/common/file_util.cpp

990 lines
29 KiB
C++
Raw Normal View History

2014-12-17 05:38:14 +00:00
// Copyright 2013 Dolphin Emulator Project / 2014 Citra Emulator Project
// Licensed under GPLv2 or any later version
// Refer to the license.txt file included.
2015-05-06 07:06:12 +00:00
#include "common/assert.h"
#include "common/common_funcs.h"
#include "common/common_paths.h"
#include "common/file_util.h"
2015-05-06 07:06:12 +00:00
#include "common/logging/log.h"
#ifdef _WIN32
#include <windows.h>
#include <shlobj.h> // for SHGetFolderPath
#include <shellapi.h>
#include <commdlg.h> // for GetSaveFileName
#include <io.h>
#include <direct.h> // getcwd
#include <tchar.h>
#include "common/string_util.h"
// 64 bit offsets for windows
#define fseeko _fseeki64
#define ftello _ftelli64
#define atoll _atoi64
#define stat64 _stat64
#define fstat64 _fstat64
#define fileno _fileno
#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__)
#include <CoreFoundation/CFString.h>
#include <CoreFoundation/CFURL.h>
#include <CoreFoundation/CFBundle.h>
#endif
#include <algorithm>
#include <sys/stat.h>
#ifndef S_ISDIR
#define S_ISDIR(m) (((m)&S_IFMT) == S_IFDIR)
#endif
#ifdef BSD4_4
#define stat64 stat
#define fstat64 fstat
#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)
{
2014-04-01 22:20:08 +00:00
if (fname.length() > 1)
{
size_t i = fname.length() - 1;
while (fname[i] == DIR_SEP_CHR)
fname[i--] = '\0';
}
return;
}
// Returns true if file filename exists
bool Exists(const std::string &filename)
{
2014-04-01 22:20:08 +00:00
struct stat64 file_info;
2014-04-01 22:20:08 +00:00
std::string copy(filename);
StripTailDirSlashes(copy);
#ifdef _WIN32
2016-03-31 10:58:37 +00:00
int result = _wstat64(Common::UTF8ToUTF16W(copy).c_str(), &file_info);
#else
2014-04-01 22:20:08 +00:00
int result = stat64(copy.c_str(), &file_info);
#endif
2014-04-01 22:20:08 +00:00
return (result == 0);
}
// Returns true if filename is a directory
bool IsDirectory(const std::string &filename)
{
2014-04-01 22:20:08 +00:00
struct stat64 file_info;
2014-04-01 22:20:08 +00:00
std::string copy(filename);
StripTailDirSlashes(copy);
#ifdef _WIN32
2016-03-31 10:58:37 +00:00
int result = _wstat64(Common::UTF8ToUTF16W(copy).c_str(), &file_info);
#else
2014-04-01 22:20:08 +00:00
int result = stat64(copy.c_str(), &file_info);
#endif
2014-04-01 22:20:08 +00:00
if (result < 0) {
LOG_WARNING(Common_Filesystem, "stat failed on %s: %s",
2014-04-01 22:20:08 +00:00
filename.c_str(), GetLastErrorMsg());
return false;
}
2014-04-01 22:20:08 +00: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)
{
LOG_INFO(Common_Filesystem, "file %s", filename.c_str());
// Return true because we care about the file no
2014-04-01 22:20:08 +00:00
// being there, not the actual delete.
if (!Exists(filename))
{
LOG_WARNING(Common_Filesystem, "%s does not exist", filename.c_str());
2014-04-01 22:20:08 +00:00
return true;
}
2014-04-01 22:20:08 +00:00
// We can't delete a directory
if (IsDirectory(filename))
{
LOG_ERROR(Common_Filesystem, "Failed: %s is a directory", filename.c_str());
2014-04-01 22:20:08 +00:00
return false;
}
#ifdef _WIN32
2016-03-31 10:58:37 +00:00
if (!DeleteFileW(Common::UTF8ToUTF16W(filename).c_str()))
2014-04-01 22:20:08 +00:00
{
LOG_ERROR(Common_Filesystem, "DeleteFile failed on %s: %s",
2014-04-01 22:20:08 +00:00
filename.c_str(), GetLastErrorMsg());
return false;
}
#else
2014-04-01 22:20:08 +00:00
if (unlink(filename.c_str()) == -1) {
LOG_ERROR(Common_Filesystem, "unlink failed on %s: %s",
2014-04-01 22:20:08 +00:00
filename.c_str(), GetLastErrorMsg());
return false;
}
#endif
2014-04-01 22:20:08 +00:00
return true;
}
// Returns true if successful, or path already exists.
bool CreateDir(const std::string &path)
{
LOG_TRACE(Common_Filesystem, "directory %s", path.c_str());
#ifdef _WIN32
2016-03-31 10:58:37 +00:00
if (::CreateDirectoryW(Common::UTF8ToUTF16W(path).c_str(), nullptr))
2014-04-01 22:20:08 +00:00
return true;
DWORD error = GetLastError();
if (error == ERROR_ALREADY_EXISTS)
{
LOG_WARNING(Common_Filesystem, "CreateDirectory failed on %s: already exists", path.c_str());
2014-04-01 22:20:08 +00:00
return true;
}
LOG_ERROR(Common_Filesystem, "CreateDirectory failed on %s: %i", path.c_str(), error);
2014-04-01 22:20:08 +00:00
return false;
#else
2014-04-01 22:20:08 +00:00
if (mkdir(path.c_str(), 0755) == 0)
return true;
2014-04-01 22:20:08 +00:00
int err = errno;
2014-04-01 22:20:08 +00:00
if (err == EEXIST)
{
LOG_WARNING(Common_Filesystem, "mkdir failed on %s: already exists", path.c_str());
2014-04-01 22:20:08 +00:00
return true;
}
LOG_ERROR(Common_Filesystem, "mkdir failed on %s: %s", path.c_str(), strerror(err));
2014-04-01 22:20:08 +00:00
return false;
#endif
}
// Creates the full path of fullPath returns true on success
bool CreateFullPath(const std::string &fullPath)
{
2014-04-01 22:20:08 +00:00
int panicCounter = 100;
LOG_TRACE(Common_Filesystem, "path %s", fullPath.c_str());
if (FileUtil::Exists(fullPath))
2014-04-01 22:20:08 +00:00
{
LOG_WARNING(Common_Filesystem, "path exists %s", fullPath.c_str());
2014-04-01 22:20:08 +00:00
return true;
}
2014-04-01 22:20:08 +00:00
size_t position = 0;
while (true)
{
// Find next sub path
position = fullPath.find(DIR_SEP_CHR, position);
2014-04-01 22:20:08 +00:00
// we're done, yay!
if (position == fullPath.npos)
return true;
2014-04-01 22:20:08 +00: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)) {
LOG_ERROR(Common, "CreateFullPath: directory creation failed");
return false;
}
2014-04-01 22:20:08 +00:00
// A safety check
panicCounter--;
if (panicCounter <= 0)
{
LOG_ERROR(Common, "CreateFullPath: directory structure is too deep");
2014-04-01 22:20:08 +00:00
return false;
}
position++;
}
}
// Deletes a directory filename, returns true on success
bool DeleteDir(const std::string &filename)
{
LOG_INFO(Common_Filesystem, "directory %s", filename.c_str());
2014-04-01 22:20:08 +00:00
// check if a directory
if (!FileUtil::IsDirectory(filename))
2014-04-01 22:20:08 +00:00
{
LOG_ERROR(Common_Filesystem, "Not a directory %s", filename.c_str());
2014-04-01 22:20:08 +00:00
return false;
}
#ifdef _WIN32
2016-03-31 10:58:37 +00:00
if (::RemoveDirectoryW(Common::UTF8ToUTF16W(filename).c_str()))
2014-04-01 22:20:08 +00:00
return true;
#else
2014-04-01 22:20:08 +00:00
if (rmdir(filename.c_str()) == 0)
return true;
#endif
LOG_ERROR(Common_Filesystem, "failed %s: %s", filename.c_str(), GetLastErrorMsg());
2014-04-01 22:20:08 +00:00
return false;
}
// renames file srcFilename to destFilename, returns true on success
bool Rename(const std::string &srcFilename, const std::string &destFilename)
{
LOG_TRACE(Common_Filesystem, "%s --> %s",
2014-04-01 22:20:08 +00:00
srcFilename.c_str(), destFilename.c_str());
2016-03-31 10:58:37 +00:00
#ifdef _WIN32
if (_wrename(Common::UTF8ToUTF16W(srcFilename).c_str(), Common::UTF8ToUTF16W(destFilename).c_str()) == 0)
return true;
#else
2014-04-01 22:20:08 +00:00
if (rename(srcFilename.c_str(), destFilename.c_str()) == 0)
return true;
2016-03-31 10:58:37 +00:00
#endif
LOG_ERROR(Common_Filesystem, "failed %s --> %s: %s",
2014-04-01 22:20:08 +00:00
srcFilename.c_str(), destFilename.c_str(), GetLastErrorMsg());
return false;
}
// copies file srcFilename to destFilename, returns true on success
bool Copy(const std::string &srcFilename, const std::string &destFilename)
{
LOG_TRACE(Common_Filesystem, "%s --> %s",
2014-04-01 22:20:08 +00:00
srcFilename.c_str(), destFilename.c_str());
#ifdef _WIN32
2016-03-31 10:58:37 +00:00
if (CopyFileW(Common::UTF8ToUTF16W(srcFilename).c_str(), Common::UTF8ToUTF16W(destFilename).c_str(), FALSE))
2014-04-01 22:20:08 +00:00
return true;
LOG_ERROR(Common_Filesystem, "failed %s --> %s: %s",
2014-04-01 22:20:08 +00:00
srcFilename.c_str(), destFilename.c_str(), GetLastErrorMsg());
return false;
#else
2014-04-01 22:20:08 +00:00
// buffer size
#define BSIZE 1024
2014-04-01 22:20:08 +00:00
char buffer[BSIZE];
// Open input file
FILE *input = fopen(srcFilename.c_str(), "rb");
if (!input)
{
LOG_ERROR(Common_Filesystem, "opening input failed %s --> %s: %s",
2014-04-01 22:20:08 +00:00
srcFilename.c_str(), destFilename.c_str(), GetLastErrorMsg());
return false;
}
// open output file
FILE *output = fopen(destFilename.c_str(), "wb");
if (!output)
{
fclose(input);
LOG_ERROR(Common_Filesystem, "opening output failed %s --> %s: %s",
2014-04-01 22:20:08 +00:00
srcFilename.c_str(), destFilename.c_str(), GetLastErrorMsg());
return false;
}
// copy loop
while (!feof(input))
{
// read input
int rnum = fread(buffer, sizeof(char), BSIZE, input);
if (rnum != BSIZE)
{
if (ferror(input) != 0)
{
LOG_ERROR(Common_Filesystem,
"failed reading from source, %s --> %s: %s",
2014-04-01 22:20:08 +00:00
srcFilename.c_str(), destFilename.c_str(), GetLastErrorMsg());
goto bail;
}
}
// write output
int wnum = fwrite(buffer, sizeof(char), rnum, output);
if (wnum != rnum)
{
LOG_ERROR(Common_Filesystem,
"failed writing to output, %s --> %s: %s",
2014-04-01 22:20:08 +00:00
srcFilename.c_str(), destFilename.c_str(), GetLastErrorMsg());
goto bail;
}
}
// close files
fclose(input);
fclose(output);
return true;
bail:
2014-04-01 22:20:08 +00:00
if (input)
fclose(input);
if (output)
fclose(output);
return false;
#endif
}
// Returns the size of filename (64bit)
u64 GetSize(const std::string &filename)
{
2014-04-01 22:20:08 +00:00
if (!Exists(filename))
{
LOG_ERROR(Common_Filesystem, "failed %s: No such file", filename.c_str());
2014-04-01 22:20:08 +00:00
return 0;
}
if (IsDirectory(filename))
{
LOG_ERROR(Common_Filesystem, "failed %s: is a directory", filename.c_str());
2014-04-01 22:20:08 +00:00
return 0;
}
2014-04-01 22:20:08 +00:00
struct stat64 buf;
#ifdef _WIN32
2016-03-31 10:58:37 +00:00
if (_wstat64(Common::UTF8ToUTF16W(filename).c_str(), &buf) == 0)
#else
2014-04-01 22:20:08 +00:00
if (stat64(filename.c_str(), &buf) == 0)
#endif
2014-04-01 22:20:08 +00:00
{
LOG_TRACE(Common_Filesystem, "%s: %lld",
2014-04-01 22:20:08 +00:00
filename.c_str(), (long long)buf.st_size);
return buf.st_size;
}
LOG_ERROR(Common_Filesystem, "Stat failed %s: %s",
2014-04-01 22:20:08 +00:00
filename.c_str(), GetLastErrorMsg());
return 0;
}
// Overloaded GetSize, accepts file descriptor
u64 GetSize(const int fd)
{
2014-04-01 22:20:08 +00:00
struct stat64 buf;
if (fstat64(fd, &buf) != 0) {
LOG_ERROR(Common_Filesystem, "GetSize: stat failed %i: %s",
2014-04-01 22:20:08 +00:00
fd, GetLastErrorMsg());
return 0;
}
return buf.st_size;
}
// Overloaded GetSize, accepts FILE*
u64 GetSize(FILE *f)
{
2014-04-01 22:20:08 +00:00
// 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 %p: %s",
2014-04-01 22:20:08 +00:00
f, GetLastErrorMsg());
return 0;
}
u64 size = ftello(f);
if ((size != pos) && (fseeko(f, pos, SEEK_SET) != 0)) {
LOG_ERROR(Common_Filesystem, "GetSize: seek failed %p: %s",
2014-04-01 22:20:08 +00:00
f, GetLastErrorMsg());
return 0;
}
return size;
}
// creates an empty file filename, returns true on success
bool CreateEmptyFile(const std::string &filename)
{
LOG_TRACE(Common_Filesystem, "%s", filename.c_str());
if (!FileUtil::IOFile(filename, "wb"))
2014-04-01 22:20:08 +00:00
{
LOG_ERROR(Common_Filesystem, "failed %s: %s",
2014-04-01 22:20:08 +00:00
filename.c_str(), GetLastErrorMsg());
return false;
}
2014-04-01 22:20:08 +00:00
return true;
}
bool ForeachDirectoryEntry(unsigned* num_entries_out, const std::string &directory, DirectoryEntryCallable callback)
{
LOG_TRACE(Common_Filesystem, "directory %s", directory.c_str());
2014-04-01 22:20:08 +00:00
// How many files + directories we found
unsigned found_entries = 0;
// Save the status of callback function
bool callback_error = false;
#ifdef _WIN32
2014-04-01 22:20:08 +00:00
// Find the first file in the directory.
2016-03-31 10:58:37 +00:00
WIN32_FIND_DATAW ffd;
2014-04-01 22:20:08 +00:00
2016-03-31 10:58:37 +00:00
HANDLE handle_find = FindFirstFileW(Common::UTF8ToUTF16W(directory + "\\*").c_str(), &ffd);
if (handle_find == INVALID_HANDLE_VALUE) {
FindClose(handle_find);
return false;
2014-04-01 22:20:08 +00:00
}
// windows loop
do {
2016-03-31 10:58:37 +00:00
const std::string virtual_name(Common::UTF16ToUTF8(ffd.cFileName));
#else
2014-12-03 18:57:57 +00:00
struct dirent dirent, *result = nullptr;
2014-04-01 22:20:08 +00:00
DIR *dirp = opendir(directory.c_str());
if (!dirp)
return false;
2014-04-01 22:20:08 +00:00
// non windows loop
while (!readdir_r(dirp, &dirent, &result) && result) {
const std::string virtual_name(result->d_name);
#endif
if (virtual_name == "." || virtual_name == "..")
2014-04-01 22:20:08 +00:00
continue;
unsigned ret_entries = 0;
if (!callback(&ret_entries, directory, virtual_name)) {
callback_error = true;
break;
}
found_entries += ret_entries;
#ifdef _WIN32
2016-03-31 10:58:37 +00:00
} while (FindNextFileW(handle_find, &ffd) != 0);
FindClose(handle_find);
#else
2014-04-01 22:20:08 +00:00
}
closedir(dirp);
#endif
if (!callback_error) {
// 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;
} else {
return false;
}
}
unsigned ScanDirectoryTree(const std::string &directory, FSTEntry& parent_entry)
{
const auto callback = [&parent_entry](unsigned* 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
entry.size = ScanDirectoryTree(entry.physicalName, entry);
*num_entries_out += (int)entry.size;
} else { // is a file
entry.isDirectory = false;
entry.size = GetSize(entry.physicalName);
}
(*num_entries_out)++;
// Push into the tree
parent_entry.children.push_back(entry);
return true;
};
2014-04-01 22:20:08 +00:00
unsigned num_entries;
return ForeachDirectoryEntry(&num_entries, directory, callback) ? num_entries : 0;
}
2014-04-01 22:20:08 +00:00
bool DeleteDirRecursively(const std::string &directory)
{
const static auto callback = [](unsigned* 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))
return DeleteDirRecursively(new_path);
return Delete(new_path);
};
if (!ForeachDirectoryEntry(nullptr, directory, callback))
return false;
// Delete the outermost directory
FileUtil::DeleteDir(directory);
2014-04-01 22:20:08 +00: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
2014-04-01 22:20:08 +00:00
if (source_path == dest_path) return;
if (!FileUtil::Exists(source_path)) return;
if (!FileUtil::Exists(dest_path)) FileUtil::CreateFullPath(dest_path);
2014-04-01 22:20:08 +00:00
2014-12-03 18:57:57 +00:00
struct dirent dirent, *result = nullptr;
2014-04-01 22:20:08 +00:00
DIR *dirp = opendir(source_path.c_str());
if (!dirp) return;
while (!readdir_r(dirp, &dirent, &result) && result)
{
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 (!FileUtil::Exists(dest)) FileUtil::CreateFullPath(dest);
2014-04-01 22:20:08 +00:00
CopyDir(source, dest);
}
else if (!FileUtil::Exists(dest)) FileUtil::Copy(source, dest);
2014-04-01 22:20:08 +00:00
}
closedir(dirp);
#endif
}
// Returns the current directory
std::string GetCurrentDir()
{
2014-04-01 22:20:08 +00:00
char *dir;
// Get the current working directory (getcwd uses malloc)
if (!(dir = getcwd(nullptr, 0))) {
LOG_ERROR(Common_Filesystem, "GetCurrentDirectory failed: %s",
2014-04-01 22:20:08 +00:00
GetLastErrorMsg());
2014-12-03 18:57:57 +00:00
return nullptr;
2014-04-01 22:20:08 +00:00
}
std::string strDir = dir;
free(dir);
return strDir;
}
// Sets the current directory to the given directory
bool SetCurrentDir(const std::string &directory)
{
return chdir(directory.c_str()) == 0;
}
#if defined(__APPLE__)
std::string GetBundleDirectory()
{
2014-04-01 22:20:08 +00: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-01 22:20:08 +00:00
return AppBundlePath;
}
#endif
#ifdef _WIN32
std::string& GetExeDirectory()
{
static std::string exe_path;
if (exe_path.empty())
2014-04-01 22:20:08 +00:00
{
TCHAR tchar_exe_path[2048];
GetModuleFileName(nullptr, tchar_exe_path, 2048);
exe_path = Common::TStrToUTF8(tchar_exe_path);
exe_path = exe_path.substr(0, exe_path.find_last_of('\\'));
2014-04-01 22:20:08 +00:00
}
return exe_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 %s.", envvar.c_str());
user_dir = GetHomeDirectory() + subdirectory;
}
ASSERT_MSG(!user_dir.empty(), "User directory %s musnt be empty.", envvar.c_str());
ASSERT_MSG(user_dir[0] == '/', "User directory %s must be absolute.", envvar.c_str());
return user_dir;
}
#endif
std::string GetSysDirectory()
{
2014-04-01 22:20:08 +00:00
std::string sysDir;
#if defined (__APPLE__)
2014-04-01 22:20:08 +00:00
sysDir = GetBundleDirectory();
sysDir += DIR_SEP;
sysDir += SYSDATA_DIR;
#else
2014-04-01 22:20:08 +00:00
sysDir = SYSDATA_DIR;
#endif
2014-04-01 22:20:08 +00:00
sysDir += DIR_SEP;
LOG_DEBUG(Common_Filesystem, "Setting to %s:", sysDir.c_str());
2014-04-01 22:20:08 +00:00
return sysDir;
}
// Returns a string with a Citra data dir or file in the user's home
// directory. To be used in "multi-user" mode (that is, installed).
const std::string& GetUserPath(const unsigned int DirIDX, const std::string &newPath)
{
2014-04-01 22:20:08 +00:00
static std::string paths[NUM_PATH_INDICES];
2014-04-01 22:20:08 +00:00
// Set up all paths and files on the first run
if (paths[D_USER_IDX].empty())
{
#ifdef _WIN32
paths[D_USER_IDX] = GetExeDirectory() + DIR_SEP USERDATA_DIR DIR_SEP;
paths[D_CONFIG_IDX] = paths[D_USER_IDX] + CONFIG_DIR DIR_SEP;
paths[D_CACHE_IDX] = paths[D_USER_IDX] + CACHE_DIR DIR_SEP;
#else
if (FileUtil::Exists(ROOT_DIR DIR_SEP USERDATA_DIR)) {
paths[D_USER_IDX] = ROOT_DIR DIR_SEP USERDATA_DIR DIR_SEP;
paths[D_CONFIG_IDX] = paths[D_USER_IDX] + CONFIG_DIR DIR_SEP;
paths[D_CACHE_IDX] = paths[D_USER_IDX] + 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");
paths[D_USER_IDX] = data_dir + DIR_SEP EMU_DATA_DIR DIR_SEP;
paths[D_CONFIG_IDX] = config_dir + DIR_SEP EMU_DATA_DIR DIR_SEP;
paths[D_CACHE_IDX] = cache_dir + DIR_SEP EMU_DATA_DIR DIR_SEP;
}
#endif
paths[D_GAMECONFIG_IDX] = paths[D_USER_IDX] + GAMECONFIG_DIR DIR_SEP;
paths[D_MAPS_IDX] = paths[D_USER_IDX] + MAPS_DIR DIR_SEP;
paths[D_SDMC_IDX] = paths[D_USER_IDX] + SDMC_DIR DIR_SEP;
paths[D_NAND_IDX] = paths[D_USER_IDX] + NAND_DIR DIR_SEP;
paths[D_SYSDATA_IDX] = paths[D_USER_IDX] + SYSDATA_DIR DIR_SEP;
2014-04-01 22:20:08 +00:00
paths[D_SHADERCACHE_IDX] = paths[D_USER_IDX] + SHADERCACHE_DIR DIR_SEP;
paths[D_SHADERS_IDX] = paths[D_USER_IDX] + SHADERS_DIR DIR_SEP;
paths[D_STATESAVES_IDX] = paths[D_USER_IDX] + STATESAVES_DIR DIR_SEP;
2014-04-01 22:20:08 +00:00
paths[D_SCREENSHOTS_IDX] = paths[D_USER_IDX] + SCREENSHOTS_DIR DIR_SEP;
paths[D_DUMP_IDX] = paths[D_USER_IDX] + DUMP_DIR DIR_SEP;
paths[D_DUMPFRAMES_IDX] = paths[D_DUMP_IDX] + DUMP_FRAMES_DIR DIR_SEP;
paths[D_DUMPAUDIO_IDX] = paths[D_DUMP_IDX] + DUMP_AUDIO_DIR DIR_SEP;
paths[D_DUMPTEXTURES_IDX] = paths[D_DUMP_IDX] + DUMP_TEXTURES_DIR DIR_SEP;
paths[D_LOGS_IDX] = paths[D_USER_IDX] + LOGS_DIR DIR_SEP;
paths[F_DEBUGGERCONFIG_IDX] = paths[D_CONFIG_IDX] + DEBUGGER_CONFIG;
paths[F_LOGGERCONFIG_IDX] = paths[D_CONFIG_IDX] + LOGGER_CONFIG;
2014-04-01 22:20:08 +00:00
paths[F_MAINLOG_IDX] = paths[D_LOGS_IDX] + MAIN_LOG;
}
if (!newPath.empty())
{
if (!FileUtil::IsDirectory(newPath))
2014-04-01 22:20:08 +00:00
{
LOG_ERROR(Common_Filesystem, "Invalid path specified %s", newPath.c_str());
2014-04-01 22:20:08 +00:00
return paths[DirIDX];
}
else
{
paths[DirIDX] = newPath;
}
switch (DirIDX)
{
case D_ROOT_IDX:
paths[D_USER_IDX] = paths[D_ROOT_IDX] + DIR_SEP;
paths[D_SYSCONF_IDX] = paths[D_USER_IDX] + SYSCONF_DIR + DIR_SEP;
paths[F_SYSCONF_IDX] = paths[D_SYSCONF_IDX] + SYSCONF;
2014-04-01 22:20:08 +00:00
break;
case D_USER_IDX:
paths[D_USER_IDX] = paths[D_ROOT_IDX] + DIR_SEP;
paths[D_CONFIG_IDX] = paths[D_USER_IDX] + CONFIG_DIR DIR_SEP;
paths[D_GAMECONFIG_IDX] = paths[D_USER_IDX] + GAMECONFIG_DIR DIR_SEP;
paths[D_MAPS_IDX] = paths[D_USER_IDX] + MAPS_DIR DIR_SEP;
paths[D_CACHE_IDX] = paths[D_USER_IDX] + CACHE_DIR DIR_SEP;
paths[D_SDMC_IDX] = paths[D_USER_IDX] + SDMC_DIR DIR_SEP;
paths[D_NAND_IDX] = paths[D_USER_IDX] + NAND_DIR DIR_SEP;
2014-04-01 22:20:08 +00:00
paths[D_SHADERCACHE_IDX] = paths[D_USER_IDX] + SHADERCACHE_DIR DIR_SEP;
paths[D_SHADERS_IDX] = paths[D_USER_IDX] + SHADERS_DIR DIR_SEP;
paths[D_STATESAVES_IDX] = paths[D_USER_IDX] + STATESAVES_DIR DIR_SEP;
2014-04-01 22:20:08 +00:00
paths[D_SCREENSHOTS_IDX] = paths[D_USER_IDX] + SCREENSHOTS_DIR DIR_SEP;
paths[D_DUMP_IDX] = paths[D_USER_IDX] + DUMP_DIR DIR_SEP;
paths[D_DUMPFRAMES_IDX] = paths[D_DUMP_IDX] + DUMP_FRAMES_DIR DIR_SEP;
paths[D_DUMPAUDIO_IDX] = paths[D_DUMP_IDX] + DUMP_AUDIO_DIR DIR_SEP;
paths[D_DUMPTEXTURES_IDX] = paths[D_DUMP_IDX] + DUMP_TEXTURES_DIR DIR_SEP;
paths[D_LOGS_IDX] = paths[D_USER_IDX] + LOGS_DIR DIR_SEP;
2014-04-01 22:20:08 +00:00
paths[D_SYSCONF_IDX] = paths[D_USER_IDX] + SYSCONF_DIR DIR_SEP;
paths[F_EMUCONFIG_IDX] = paths[D_CONFIG_IDX] + EMU_CONFIG;
paths[F_DEBUGGERCONFIG_IDX] = paths[D_CONFIG_IDX] + DEBUGGER_CONFIG;
paths[F_LOGGERCONFIG_IDX] = paths[D_CONFIG_IDX] + LOGGER_CONFIG;
2014-04-01 22:20:08 +00:00
paths[F_MAINLOG_IDX] = paths[D_LOGS_IDX] + MAIN_LOG;
break;
case D_CONFIG_IDX:
paths[F_EMUCONFIG_IDX] = paths[D_CONFIG_IDX] + EMU_CONFIG;
paths[F_DEBUGGERCONFIG_IDX] = paths[D_CONFIG_IDX] + DEBUGGER_CONFIG;
paths[F_LOGGERCONFIG_IDX] = paths[D_CONFIG_IDX] + LOGGER_CONFIG;
2014-04-01 22:20:08 +00:00
break;
case D_DUMP_IDX:
paths[D_DUMPFRAMES_IDX] = paths[D_DUMP_IDX] + DUMP_FRAMES_DIR DIR_SEP;
paths[D_DUMPAUDIO_IDX] = paths[D_DUMP_IDX] + DUMP_AUDIO_DIR DIR_SEP;
paths[D_DUMPTEXTURES_IDX] = paths[D_DUMP_IDX] + DUMP_TEXTURES_DIR DIR_SEP;
2014-04-01 22:20:08 +00:00
break;
case D_LOGS_IDX:
paths[F_MAINLOG_IDX] = paths[D_LOGS_IDX] + MAIN_LOG;
}
}
2014-04-01 22:20:08 +00:00
return paths[DirIDX];
}
2014-09-28 15:30:29 +00:00
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());
}
2014-09-28 15:30:29 +00:00
size_t ReadFileToString(bool text_file, const char *filename, std::string &str)
{
FileUtil::IOFile file(filename, text_file ? "r" : "rb");
2014-04-01 22:20:08 +00:00
auto const f = file.GetHandle();
2014-04-01 22:20:08 +00:00
if (!f)
return false;
2014-04-01 22:20:08 +00:00
str.resize(static_cast<u32>(GetSize(f)));
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);
}
}
IOFile::IOFile()
2014-12-03 18:57:57 +00:00
: m_file(nullptr), m_good(true)
{}
IOFile::IOFile(std::FILE* file)
2014-04-01 22:20:08 +00:00
: m_file(file), m_good(true)
{}
IOFile::IOFile(const std::string& filename, const char openmode[])
2014-12-03 18:57:57 +00:00
: m_file(nullptr), m_good(true)
{
2014-04-01 22:20:08 +00:00
Open(filename, openmode);
}
IOFile::~IOFile()
{
2014-04-01 22:20:08 +00:00
Close();
}
IOFile::IOFile(IOFile&& other)
2014-12-03 18:57:57 +00:00
: m_file(nullptr), m_good(true)
{
2014-04-01 22:20:08 +00:00
Swap(other);
}
IOFile& IOFile::operator=(IOFile&& other)
{
2014-04-01 22:20:08 +00:00
Swap(other);
return *this;
}
void IOFile::Swap(IOFile& other)
{
2014-04-01 22:20:08 +00:00
std::swap(m_file, other.m_file);
std::swap(m_good, other.m_good);
}
bool IOFile::Open(const std::string& filename, const char openmode[])
{
2014-04-01 22:20:08 +00:00
Close();
#ifdef _WIN32
2016-03-31 10:58:37 +00:00
_wfopen_s(&m_file, Common::UTF8ToUTF16W(filename).c_str(), Common::UTF8ToUTF16W(openmode).c_str());
#else
2014-04-01 22:20:08 +00:00
m_file = fopen(filename.c_str(), openmode);
#endif
2014-04-01 22:20:08 +00:00
m_good = IsOpen();
return m_good;
}
bool IOFile::Close()
{
2014-04-01 22:20:08 +00:00
if (!IsOpen() || 0 != std::fclose(m_file))
m_good = false;
2014-12-03 18:57:57 +00:00
m_file = nullptr;
2014-04-01 22:20:08 +00:00
return m_good;
}
std::FILE* IOFile::ReleaseHandle()
{
2014-04-01 22:20:08 +00:00
std::FILE* const ret = m_file;
2014-12-03 18:57:57 +00:00
m_file = nullptr;
2014-04-01 22:20:08 +00:00
return ret;
}
void IOFile::SetHandle(std::FILE* file)
{
2014-04-01 22:20:08 +00:00
Close();
Clear();
m_file = file;
}
u64 IOFile::GetSize()
{
2014-04-01 22:20:08 +00:00
if (IsOpen())
return FileUtil::GetSize(m_file);
2014-04-01 22:20:08 +00:00
else
return 0;
}
bool IOFile::Seek(s64 off, int origin)
{
2014-04-01 22:20:08 +00:00
if (!IsOpen() || 0 != fseeko(m_file, off, origin))
m_good = false;
2014-04-01 22:20:08 +00:00
return m_good;
}
u64 IOFile::Tell()
{
2014-04-01 22:20:08 +00:00
if (IsOpen())
return ftello(m_file);
else
return -1;
}
bool IOFile::Flush()
{
2014-04-01 22:20:08 +00:00
if (!IsOpen() || 0 != std::fflush(m_file))
m_good = false;
2014-04-01 22:20:08 +00:00
return m_good;
}
bool IOFile::Resize(u64 size)
{
2014-04-01 22:20:08 +00:00
if (!IsOpen() || 0 !=
#ifdef _WIN32
2014-04-01 22:20:08 +00:00
// 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
2014-04-01 22:20:08 +00:00
// TODO: handle 64bit and growing
ftruncate(fileno(m_file), size)
#endif
2014-04-01 22:20:08 +00:00
)
m_good = false;
2014-04-01 22:20:08 +00:00
return m_good;
}
} // namespace