// Copyright (C) 2003 Dolphin Project. // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, version 2.0 or later versions. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License 2.0 for more details. // A copy of the GPL 2.0 should have been included with the program. // If not, see http://www.gnu.org/licenses/ // Official SVN repository and contact information can be found at // http://code.google.com/p/dolphin-emu/ #if defined(_MSC_VER) #pragma warning(disable:4091) // workaround bug in VS2015 headers #ifndef UNICODE #error Win32 build requires a unicode build #endif #endif #include "ppsspp_config.h" #include "FileUtil.h" #include "StringUtils.h" #ifdef _WIN32 #include "CommonWindows.h" #include // for SHGetFolderPath #include #include // for GetSaveFileName #include #include // getcwd #else #include #include #include #include #include #endif #if defined(__DragonFly__) || defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__NetBSD__) #include // KERN_PROC_PATHNAME #endif #if defined(__APPLE__) #include #include #include #if !defined(IOS) #include #endif // !defined(IOS) #endif // __APPLE__ #include "util/text/utf8.h" #include #ifndef S_ISDIR #define S_ISDIR(m) (((m)&S_IFMT) == S_IFDIR) #endif #if !defined(__linux__) && !defined(_WIN32) && !defined(__QNX__) #define stat64 stat #define fstat64 fstat #endif #define DIR_SEP "/" #ifdef _WIN32 #define DIR_SEP_CHRS "/\\" #else #define DIR_SEP_CHRS "/" #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 File { FILE *OpenCFile(const std::string &filename, const char *mode) { #if defined(_WIN32) && defined(UNICODE) return _wfopen(ConvertUTF8ToWString(filename).c_str(), ConvertUTF8ToWString(mode).c_str()); #else return fopen(filename.c_str(), mode); #endif } bool OpenCPPFile(std::fstream & stream, const std::string &filename, std::ios::openmode mode) { #if defined(_WIN32) && defined(UNICODE) && !defined(__MINGW32__) stream.open(ConvertUTF8ToWString(filename), mode); #else stream.open(filename.c_str(), mode); #endif return stream.is_open(); } // Remove any ending forward slashes from directory paths // Modifies argument. static void StripTailDirSlashes(std::string &fname) { if (fname.length() > 1) { size_t i = fname.length() - 1; #ifdef _WIN32 if (i == 2 && fname[1] == ':' && fname[2] == '\\') return; #endif while (strchr(DIR_SEP_CHRS, fname[i])) fname[i--] = '\0'; } return; } // Returns true if file filename exists. Will return true on directories. bool Exists(const std::string &filename) { std::string fn = filename; StripTailDirSlashes(fn); #if defined(_WIN32) std::wstring copy = ConvertUTF8ToWString(fn); // Make sure Windows will no longer handle critical errors, which means no annoying "No disk" dialog #if !PPSSPP_PLATFORM(UWP) int OldMode = SetErrorMode(SEM_FAILCRITICALERRORS); #endif WIN32_FILE_ATTRIBUTE_DATA data{}; if (!GetFileAttributesEx(copy.c_str(), GetFileExInfoStandard, &data) || data.dwFileAttributes == INVALID_FILE_ATTRIBUTES) { return false; } #if !PPSSPP_PLATFORM(UWP) SetErrorMode(OldMode); #endif return true; #else struct stat file_info; return stat(fn.c_str(), &file_info) == 0; #endif } // Returns true if filename is a directory bool IsDirectory(const std::string &filename) { std::string fn = filename; StripTailDirSlashes(fn); #if defined(_WIN32) std::wstring copy = ConvertUTF8ToWString(fn); WIN32_FILE_ATTRIBUTE_DATA data{}; if (!GetFileAttributesEx(copy.c_str(), GetFileExInfoStandard, &data) || data.dwFileAttributes == INVALID_FILE_ATTRIBUTES) { WARN_LOG(COMMON, "GetFileAttributes failed on %s: %08x", fn.c_str(), GetLastError()); return false; } DWORD result = data.dwFileAttributes; return (result & FILE_ATTRIBUTE_DIRECTORY) == FILE_ATTRIBUTE_DIRECTORY; #else std::string copy(fn); struct stat file_info; int result = stat(copy.c_str(), &file_info); if (result < 0) { WARN_LOG(COMMON, "IsDirectory: stat failed on %s: %s", fn.c_str(), GetLastErrorMsg()); return false; } return S_ISDIR(file_info.st_mode); #endif } // Deletes a given filename, return true on success // Doesn't supports deleting a directory bool Delete(const std::string &filename) { INFO_LOG(COMMON, "Delete: file %s", filename.c_str()); // Return true because we care about the file no // being there, not the actual delete. if (!Exists(filename)) { WARN_LOG(COMMON, "Delete: %s does not exists", filename.c_str()); return true; } // We can't delete a directory if (IsDirectory(filename)) { WARN_LOG(COMMON, "Delete failed: %s is a directory", filename.c_str()); return false; } #ifdef _WIN32 if (!DeleteFile(ConvertUTF8ToWString(filename).c_str())) { WARN_LOG(COMMON, "Delete: DeleteFile failed on %s: %s", filename.c_str(), GetLastErrorMsg()); return false; } #else if (unlink(filename.c_str()) == -1) { WARN_LOG(COMMON, "Delete: unlink failed on %s: %s", filename.c_str(), GetLastErrorMsg()); return false; } #endif return true; } // Returns true if successful, or path already exists. bool CreateDir(const std::string &path) { DEBUG_LOG(COMMON, "CreateDir('%s')", path.c_str()); #ifdef _WIN32 if (::CreateDirectory(ConvertUTF8ToWString(path).c_str(), NULL)) return true; DWORD error = GetLastError(); if (error == ERROR_ALREADY_EXISTS) { WARN_LOG(COMMON, "CreateDir: CreateDirectory failed on %s: already exists", path.c_str()); return true; } ERROR_LOG(COMMON, "CreateDir: CreateDirectory failed on %s: %i", path.c_str(), error); return false; #else if (mkdir(path.c_str(), 0755) == 0) return true; int err = errno; if (err == EEXIST) { WARN_LOG(COMMON, "CreateDir: mkdir failed on %s: already exists", path.c_str()); return true; } ERROR_LOG(COMMON, "CreateDir: mkdir failed on %s: %s", path.c_str(), strerror(err)); return false; #endif } // Creates the full path of fullPath returns true on success bool CreateFullPath(const std::string &fullPath) { int panicCounter = 100; DEBUG_LOG(COMMON, "CreateFullPath: path %s", fullPath.c_str()); if (File::Exists(fullPath)) { DEBUG_LOG(COMMON, "CreateFullPath: path exists %s", fullPath.c_str()); return true; } size_t position = 0; #ifdef _WIN32 // Skip the drive letter, no need to create C:\. position = 3; #endif while (true) { // Find next sub path position = fullPath.find_first_of(DIR_SEP_CHRS, position); // we're done, yay! if (position == fullPath.npos) { if (!File::Exists(fullPath)) return File::CreateDir(fullPath); return true; } std::string subPath = fullPath.substr(0, position); if (!File::Exists(subPath)) File::CreateDir(subPath); // A safety check panicCounter--; if (panicCounter <= 0) { ERROR_LOG(COMMON, "CreateFullPath: directory structure too deep"); return false; } position++; } } // Deletes a directory filename, returns true on success bool DeleteDir(const std::string &filename) { INFO_LOG(COMMON, "DeleteDir: directory %s", filename.c_str()); // check if a directory if (!File::IsDirectory(filename)) { ERROR_LOG(COMMON, "DeleteDir: Not a directory %s", filename.c_str()); return false; } #ifdef _WIN32 if (::RemoveDirectory(ConvertUTF8ToWString(filename).c_str())) return true; #else if (rmdir(filename.c_str()) == 0) return true; #endif ERROR_LOG(COMMON, "DeleteDir: %s: %s", filename.c_str(), GetLastErrorMsg()); return false; } // renames file srcFilename to destFilename, returns true on success bool Rename(const std::string &srcFilename, const std::string &destFilename) { INFO_LOG(COMMON, "Rename: %s --> %s", srcFilename.c_str(), destFilename.c_str()); #if defined(_WIN32) && defined(UNICODE) std::wstring srcw = ConvertUTF8ToWString(srcFilename); std::wstring destw = ConvertUTF8ToWString(destFilename); if (_wrename(srcw.c_str(), destw.c_str()) == 0) return true; #else if (rename(srcFilename.c_str(), destFilename.c_str()) == 0) return true; #endif ERROR_LOG(COMMON, "Rename: failed %s --> %s: %s", 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) { INFO_LOG(COMMON, "Copy: %s --> %s", srcFilename.c_str(), destFilename.c_str()); #ifdef _WIN32 #if PPSSPP_PLATFORM(UWP) if (CopyFile2(ConvertUTF8ToWString(srcFilename).c_str(), ConvertUTF8ToWString(destFilename).c_str(), nullptr)) return true; return false; #else if (CopyFile(ConvertUTF8ToWString(srcFilename).c_str(), ConvertUTF8ToWString(destFilename).c_str(), FALSE)) return true; #endif ERROR_LOG(COMMON, "Copy: failed %s --> %s: %s", srcFilename.c_str(), destFilename.c_str(), GetLastErrorMsg()); return false; #else // buffer size #define BSIZE 1024 char buffer[BSIZE]; // Open input file FILE *input = fopen(srcFilename.c_str(), "rb"); if (!input) { ERROR_LOG(COMMON, "Copy: input failed %s --> %s: %s", srcFilename.c_str(), destFilename.c_str(), GetLastErrorMsg()); return false; } // open output file FILE *output = fopen(destFilename.c_str(), "wb"); if (!output) { fclose(input); ERROR_LOG(COMMON, "Copy: output failed %s --> %s: %s", 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) { ERROR_LOG(COMMON, "Copy: failed reading from source, %s --> %s: %s", srcFilename.c_str(), destFilename.c_str(), GetLastErrorMsg()); fclose(input); fclose(output); return false; } } // write output int wnum = fwrite(buffer, sizeof(char), rnum, output); if (wnum != rnum) { ERROR_LOG(COMMON, "Copy: failed writing to output, %s --> %s: %s", srcFilename.c_str(), destFilename.c_str(), GetLastErrorMsg()); fclose(input); fclose(output); return false; } } // close flushs fclose(input); fclose(output); return true; #endif } #ifdef _WIN32 static int64_t FiletimeToStatTime(FILETIME ft) { const int windowsTickResolution = 10000000; const int64_t secToUnixEpoch = 11644473600LL; int64_t ticks = ((uint64_t)ft.dwHighDateTime << 32) | ft.dwLowDateTime; return (int64_t)(ticks / windowsTickResolution - secToUnixEpoch); } #endif // Returns file attributes. bool GetFileDetails(const std::string &filename, FileDetails *details) { #ifdef _WIN32 WIN32_FILE_ATTRIBUTE_DATA attr; if (!GetFileAttributesEx(ConvertUTF8ToWString(filename).c_str(), GetFileExInfoStandard, &attr)) return false; details->isDirectory = (attr.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) != 0; details->size = ((u64)attr.nFileSizeHigh << 32) | (u64)attr.nFileSizeLow; details->atime = FiletimeToStatTime(attr.ftLastAccessTime); details->mtime = FiletimeToStatTime(attr.ftLastWriteTime); details->ctime = FiletimeToStatTime(attr.ftCreationTime); if (attr.dwFileAttributes & FILE_ATTRIBUTE_READONLY) { details->access = 0444; // Read } else { details->access = 0666; // Read/Write } if (attr.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) { details->access |= 0111; // Execute } return true; #else if (!Exists(filename)) { return false; } #if __ANDROID__ && __ANDROID_API__ < 21 struct stat buf; if (stat(filename.c_str(), &buf) == 0) { #else struct stat64 buf; if (stat64(filename.c_str(), &buf) == 0) { #endif details->size = buf.st_size; details->isDirectory = S_ISDIR(buf.st_mode); details->atime = buf.st_atime; details->mtime = buf.st_mtime; details->ctime = buf.st_ctime; details->access = buf.st_mode & 0x1ff; return true; } else { return false; } #endif } bool GetModifTime(const std::string &filename, tm &return_time) { memset(&return_time, 0, sizeof(return_time)); FileDetails details; if (GetFileDetails(filename, &details)) { time_t t = details.mtime; localtime_r((time_t*)&t, &return_time); return true; } else { return false; } } std::string GetDir(const std::string &path) { if (path == "/") return path; int n = (int)path.size() - 1; while (n >= 0 && path[n] != '\\' && path[n] != '/') n--; std::string cutpath = n > 0 ? path.substr(0, n) : ""; for (size_t i = 0; i < cutpath.size(); i++) { if (cutpath[i] == '\\') cutpath[i] = '/'; } #ifndef _WIN32 if (!cutpath.size()) { return "/"; } #endif return cutpath; } std::string GetFilename(std::string path) { size_t off = GetDir(path).size() + 1; if (off < path.size()) return path.substr(off); else return path; } // Returns the size of file (64bit) // TODO: Add a way to return an error. u64 GetFileSize(const std::string &filename) { #if defined(_WIN32) && defined(UNICODE) WIN32_FILE_ATTRIBUTE_DATA attr; if (!GetFileAttributesEx(ConvertUTF8ToWString(filename).c_str(), GetFileExInfoStandard, &attr)) return 0; if (attr.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) return 0; return ((u64)attr.nFileSizeHigh << 32) | (u64)attr.nFileSizeLow; #else #if __ANDROID__ && __ANDROID_API__ < 21 struct stat file_info; int result = stat(filename.c_str(), &file_info); #else struct stat64 file_info; int result = stat64(filename.c_str(), &file_info); #endif if (result != 0) { WARN_LOG(COMMON, "GetSize: failed %s: No such file", filename.c_str()); return 0; } if (S_ISDIR(file_info.st_mode)) { WARN_LOG(COMMON, "GetSize: failed %s: is a directory", filename.c_str()); return 0; } DEBUG_LOG(COMMON, "GetSize: %s: %lld", filename.c_str(), (long long)file_info.st_size); return file_info.st_size; #endif } // Overloaded GetSize, accepts FILE* u64 GetFileSize(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) { ERROR_LOG(COMMON, "GetSize: seek failed %p: %s", f, GetLastErrorMsg()); return 0; } u64 size = ftello(f); if ((size != pos) && (fseeko(f, pos, SEEK_SET) != 0)) { ERROR_LOG(COMMON, "GetSize: seek failed %p: %s", f, GetLastErrorMsg()); return 0; } return size; } // creates an empty file filename, returns true on success bool CreateEmptyFile(const std::string &filename) { INFO_LOG(COMMON, "CreateEmptyFile: %s", filename.c_str()); FILE *pFile = OpenCFile(filename, "wb"); if (!pFile) { ERROR_LOG(COMMON, "CreateEmptyFile: failed %s: %s", filename.c_str(), GetLastErrorMsg()); return false; } fclose(pFile); return true; } // Deletes the given directory and anything under it. Returns true on success. bool DeleteDirRecursively(const std::string &directory) { #if PPSSPP_PLATFORM(UWP) return false; #else INFO_LOG(COMMON, "DeleteDirRecursively: %s", directory.c_str()); #ifdef _WIN32 // Find the first file in the directory. WIN32_FIND_DATA ffd; HANDLE hFind = FindFirstFile(ConvertUTF8ToWString(directory + "\\*").c_str(), &ffd); if (hFind == INVALID_HANDLE_VALUE) { FindClose(hFind); return false; } // windows loop do { const std::string virtualName = ConvertWStringToUTF8(ffd.cFileName); #else struct dirent dirent, *result = NULL; DIR *dirp = opendir(directory.c_str()); if (!dirp) return false; // non windows loop while (!readdir_r(dirp, &dirent, &result) && result) { const std::string virtualName = result->d_name; #endif // check for "." and ".." if (((virtualName[0] == '.') && (virtualName[1] == '\0')) || ((virtualName[0] == '.') && (virtualName[1] == '.') && (virtualName[2] == '\0'))) continue; std::string newPath = directory + DIR_SEP + virtualName; if (IsDirectory(newPath)) { if (!DeleteDirRecursively(newPath)) { #ifndef _WIN32 closedir(dirp); #endif return false; } } else { if (!File::Delete(newPath)) { #ifndef _WIN32 closedir(dirp); #endif return false; } } #ifdef _WIN32 } while (FindNextFile(hFind, &ffd) != 0); FindClose(hFind); #else } closedir(dirp); #endif File::DeleteDir(directory); return true; #endif } // 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 (!File::Exists(source_path)) return; if (!File::Exists(dest_path)) File::CreateFullPath(dest_path); struct dirent_large { struct dirent entry; char padding[FILENAME_MAX+1]; }; struct dirent_large diren; struct dirent *result = NULL; DIR *dirp = opendir(source_path.c_str()); if (!dirp) return; while (!readdir_r(dirp, (dirent*) &diren, &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 (!File::Exists(dest)) File::CreateFullPath(dest); CopyDir(source, dest); } else if (!File::Exists(dest)) File::Copy(source, dest); } closedir(dirp); #else ERROR_LOG(COMMON, "CopyDir not supported on this platform"); #endif } void openIniFile(const std::string fileName) { std::string iniFile; #if defined(_WIN32) #if PPSSPP_PLATFORM(UWP) // Do nothing. #else iniFile = fileName; // Can't rely on a .txt file extension to auto-open in the right editor, // so let's find notepad wchar_t notepad_path[MAX_PATH + 1]; GetSystemDirectory(notepad_path, MAX_PATH); wcscat(notepad_path, L"\\notepad.exe"); wchar_t ini_path[MAX_PATH + 1] = { 0 }; wcsncpy(ini_path, ConvertUTF8ToWString(iniFile).c_str(), MAX_PATH); // Flip any slashes... for (size_t i = 0; i < wcslen(ini_path); i++) { if (ini_path[i] == '/') ini_path[i] = '\\'; } // One for the space, one for the null. wchar_t command_line[MAX_PATH * 2 + 1 + 1]; wsprintf(command_line, L"%s %s", notepad_path, ini_path); STARTUPINFO si; memset(&si, 0, sizeof(si)); si.cb = sizeof(si); si.wShowWindow = SW_SHOW; PROCESS_INFORMATION pi; memset(&pi, 0, sizeof(pi)); UINT retval = CreateProcess(0, command_line, 0, 0, 0, 0, 0, 0, &si, &pi); if (!retval) { ERROR_LOG(COMMON, "Failed creating notepad process"); } CloseHandle(pi.hThread); CloseHandle(pi.hProcess); #endif #elif !defined(MOBILE_DEVICE) #if defined(__APPLE__) iniFile = "open "; #else iniFile = "xdg-open "; #endif iniFile.append(fileName); NOTICE_LOG(BOOT, "Launching %s", iniFile.c_str()); int retval = system(iniFile.c_str()); if (retval != 0) { ERROR_LOG(COMMON, "Failed to launch ini file"); } #endif } const std::string &GetExeDirectory() { static std::string ExePath; if (ExePath.empty()) { #ifdef _WIN32 TCHAR program_path[4096] = {0}; GetModuleFileName(NULL, program_path, ARRAY_SIZE(program_path) - 1); program_path[ARRAY_SIZE(program_path) - 1] = '\0'; TCHAR *last_slash = _tcsrchr(program_path, '\\'); if (last_slash != NULL) *(last_slash + 1) = '\0'; #ifdef UNICODE ExePath = ConvertWStringToUTF8(program_path); #else ExePath = program_path; #endif #elif (defined(__APPLE__) && !defined(IOS)) || defined(__linux__) || defined(KERN_PROC_PATHNAME) char program_path[4096]; uint32_t program_path_size = sizeof(program_path) - 1; #if defined(__linux__) if (readlink("/proc/self/exe", program_path, 4095) > 0) #elif defined(__APPLE__) && !defined(IOS) if (_NSGetExecutablePath(program_path, &program_path_size) == 0) #elif defined(KERN_PROC_PATHNAME) int mib[4] = { CTL_KERN, #if defined(__NetBSD__) KERN_PROC_ARGS, -1, KERN_PROC_PATHNAME, #else KERN_PROC, KERN_PROC_PATHNAME, -1, #endif }; size_t sz = program_path_size; if (sysctl(mib, 4, program_path, &sz, NULL, 0) == 0) #else #error Unmatched ifdef. #endif { program_path[sizeof(program_path) - 1] = '\0'; char *last_slash = strrchr(program_path, '/'); if (last_slash != NULL) *(last_slash + 1) = '\0'; ExePath = program_path; } #endif } return ExePath; } IOFile::IOFile() : m_file(NULL), m_good(true) {} IOFile::IOFile(std::FILE* file) : m_file(file), m_good(true) {} IOFile::IOFile(const std::string& filename, const char openmode[]) : m_file(NULL), m_good(true) { Open(filename, openmode); } IOFile::~IOFile() { Close(); } bool IOFile::Open(const std::string& filename, const char openmode[]) { Close(); m_file = File::OpenCFile(filename, openmode); m_good = IsOpen(); return m_good; } bool IOFile::Close() { if (!IsOpen() || 0 != std::fclose(m_file)) m_good = false; m_file = NULL; return m_good; } std::FILE* IOFile::ReleaseHandle() { std::FILE* const ret = m_file; m_file = NULL; return ret; } void IOFile::SetHandle(std::FILE* file) { Close(); Clear(); m_file = file; } u64 IOFile::GetSize() { if (IsOpen()) return File::GetFileSize(m_file); else return 0; } bool IOFile::Seek(s64 off, int origin) { if (!IsOpen() || 0 != fseeko(m_file, off, origin)) m_good = false; return m_good; } u64 IOFile::Tell() { if (IsOpen()) return ftello(m_file); else return -1; } bool IOFile::Flush() { if (!IsOpen() || 0 != std::fflush(m_file)) m_good = false; return m_good; } bool IOFile::Resize(u64 size) { if (!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 ) m_good = false; return m_good; } } // namespace