X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;ds=inline;f=src%2Fporting.cpp;h=caf9e9be340aa58db45e806e6c7cdf7da1f3ece7;hb=b0b9732359d43325c8bd820abeb8417353365a0c;hp=7c7ce48eae3a62265bab4856e867334daeff3f95;hpb=f1bdc6b187836f9741ac0512a0f10414002c647d;p=dragonfireclient.git diff --git a/src/porting.cpp b/src/porting.cpp index 7c7ce48ea..caf9e9be3 100644 --- a/src/porting.cpp +++ b/src/porting.cpp @@ -1,18 +1,18 @@ /* -Minetest-c55 -Copyright (C) 2010 celeron55, Perttu Ahola +Minetest +Copyright (C) 2013 celeron55, Perttu Ahola 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; either version 2 of the License, or +it under the terms of the GNU Lesser General Public License as published by +the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. 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 for more details. +GNU Lesser General Public License for more details. -You should have received a copy of the GNU General Public License along +You should have received a copy of the GNU Lesser General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ @@ -24,8 +24,60 @@ with this program; if not, write to the Free Software Foundation, Inc., */ #include "porting.h" + +#if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__DragonFly__) || defined(__OpenBSD__) + #include + #include + extern char **environ; +#elif defined(_WIN32) + #include + #include + #include + #include + #include + #include +#endif +#if !defined(_WIN32) + #include + #include + #if !defined(__ANDROID__) + #include + #endif +#endif +#if defined(__hpux) + #define _PSTAT64 + #include +#endif +#if defined(__ANDROID__) + #include "porting_android.h" +#endif +#if defined(__APPLE__) + // For _NSGetEnviron() + // Related: https://gitlab.haskell.org/ghc/ghc/issues/2458 + #include +#endif + +#if defined(__HAIKU__) + #include +#endif + #include "config.h" #include "debug.h" +#include "filesys.h" +#include "log.h" +#include "util/string.h" +#include +#include +#include + +#if !defined(SERVER) && defined(_WIN32) +// On Windows export some driver-specific variables to encourage Minetest to be +// executed on the discrete GPU in case of systems with two. Portability is fun. +extern "C" { + __declspec(dllexport) DWORD NvOptimusEnablement = 1; + __declspec(dllexport) DWORD AmdPowerXpressRequestHighPerformance = 1; +} +#endif namespace porting { @@ -36,7 +88,7 @@ namespace porting bool g_killed = false; -bool * signal_handler_killstatus(void) +bool *signal_handler_killstatus() { return &g_killed; } @@ -44,46 +96,83 @@ bool * signal_handler_killstatus(void) #if !defined(_WIN32) // POSIX #include -void sigint_handler(int sig) +void signal_handler(int sig) { - if(g_killed == false) - { - dstream< + +BOOL WINAPI event_handler(DWORD sig) +{ + switch (sig) { + case CTRL_C_EVENT: + case CTRL_CLOSE_EVENT: + case CTRL_LOGOFF_EVENT: + case CTRL_SHUTDOWN_EVENT: + if (!g_killed) { + dstream << "INFO: event_handler(): " + << "Ctrl+C, Close Event, Logoff Event or Shutdown Event," + " shutting down." << std::endl; + g_killed = true; + } else { + (void)signal(SIGINT, SIG_DFL); + } + break; + case CTRL_BREAK_EVENT: + break; + } + + return TRUE; +} void signal_handler_init(void) { - // No-op + SetConsoleCtrlHandler((PHANDLER_ROUTINE)event_handler, TRUE); } #endif + /* Path mangler */ -std::string path_data = "../data"; -std::string path_userdata = "../"; +// Default to RUN_IN_PLACE style relative paths +std::string path_share = ".."; +std::string path_user = ".."; +std::string path_locale = path_share + DIR_DELIM + "locale"; +std::string path_cache = path_user + DIR_DELIM + "cache"; + + +std::string getDataPath(const char *subpath) +{ + return path_share + DIR_DELIM + subpath; +} void pathRemoveFile(char *path, char delim) { @@ -97,134 +186,606 @@ void pathRemoveFile(char *path, char delim) path[i] = 0; } -void initializePaths() +bool detectMSVCBuildDir(const std::string &path) { -#ifdef RUN_IN_PLACE - /* - Use relative paths if RUN_IN_PLACE - */ - - dstream<<"Using relative paths (RUN_IN_PLACE)"< - - const DWORD buflen = 1000; - char buf[buflen]; - DWORD len; - - // Find path of executable and set path_data relative to it - len = GetModuleFileName(GetModuleHandle(NULL), buf, buflen); - assert(len < buflen); - pathRemoveFile(buf, '\\'); + const char *ends[] = { + "bin\\Release", + "bin\\MinSizeRel", + "bin\\RelWithDebInfo", + "bin\\Debug", + "bin\\Build", + NULL + }; + return (!removeStringEnd(path, ends).empty()); +} - // Use "./bin/../data" - path_data = std::string(buf) + "/../data"; - - // Use "./bin/../" - path_userdata = std::string(buf) + "/../"; - - /* - Linux - */ - #elif defined(linux) - #include - - char buf[BUFSIZ]; - memset(buf, 0, BUFSIZ); - // Get path to executable - assert(readlink("/proc/self/exe", buf, BUFSIZ-1) != -1); - - pathRemoveFile(buf, '/'); +std::string get_sysinfo() +{ +#ifdef _WIN32 + + std::ostringstream oss; + LPSTR filePath = new char[MAX_PATH]; + UINT blockSize; + VS_FIXEDFILEINFO *fixedFileInfo; + + GetSystemDirectoryA(filePath, MAX_PATH); + PathAppendA(filePath, "kernel32.dll"); - // Use "./bin/../data" - path_data = std::string(buf) + "/../data"; - - // Use "./bin/../" - path_userdata = std::string(buf) + "/../"; - - /* - OS X - */ - #elif defined(__APPLE__) - - //TODO: Get path of executable. This assumes working directory is bin/ - dstream<<"WARNING: Relative path not properly supported on OS X" - <dwProductVersionMS) << '.' // Major + << LOWORD(fixedFileInfo->dwProductVersionMS) << '.' // Minor + << HIWORD(fixedFileInfo->dwProductVersionLS) << ' '; // Build + + #ifdef _WIN64 + oss << "x86_64"; + #else + BOOL is64 = FALSE; + if (IsWow64Process(GetCurrentProcess(), &is64) && is64) + oss << "x86_64"; // 32-bit app on 64-bit OS + else + oss << "x86"; #endif -#else // RUN_IN_PLACE + delete[] lpVersionInfo; + delete[] filePath; + + return oss.str(); +#else + struct utsname osinfo; + uname(&osinfo); + return std::string(osinfo.sysname) + "/" + + osinfo.release + " " + osinfo.machine; +#endif +} + + +bool getCurrentWorkingDir(char *buf, size_t len) +{ +#ifdef _WIN32 + DWORD ret = GetCurrentDirectory(len, buf); + return (ret != 0) && (ret <= len); +#else + return getcwd(buf, len); +#endif +} + + +bool getExecPathFromProcfs(char *buf, size_t buflen) +{ +#ifndef _WIN32 + buflen--; + + ssize_t len; + if ((len = readlink("/proc/self/exe", buf, buflen)) == -1 && + (len = readlink("/proc/curproc/file", buf, buflen)) == -1 && + (len = readlink("/proc/curproc/exe", buf, buflen)) == -1) + return false; + + buf[len] = '\0'; + return true; +#else + return false; +#endif +} + +//// Windows +#if defined(_WIN32) + +bool getCurrentExecPath(char *buf, size_t len) +{ + DWORD written = GetModuleFileNameA(NULL, buf, len); + if (written == 0 || written == len) + return false; + + return true; +} + + +//// Linux +#elif defined(__linux__) + +bool getCurrentExecPath(char *buf, size_t len) +{ + if (!getExecPathFromProcfs(buf, len)) + return false; + + return true; +} + + +//// Mac OS X, Darwin +#elif defined(__APPLE__) + +bool getCurrentExecPath(char *buf, size_t len) +{ + uint32_t lenb = (uint32_t)len; + if (_NSGetExecutablePath(buf, &lenb) == -1) + return false; + + return true; +} + + +//// FreeBSD, NetBSD, DragonFlyBSD +#elif defined(__FreeBSD__) || defined(__NetBSD__) || defined(__DragonFly__) + +bool getCurrentExecPath(char *buf, size_t len) +{ + // Try getting path from procfs first, since valgrind + // doesn't work with the latter + if (getExecPathFromProcfs(buf, len)) + return true; + + int mib[4]; + + mib[0] = CTL_KERN; + mib[1] = KERN_PROC; + mib[2] = KERN_PROC_PATHNAME; + mib[3] = -1; + + if (sysctl(mib, 4, buf, &len, NULL, 0) == -1) + return false; + + return true; +} + +#elif defined(__HAIKU__) + +bool getCurrentExecPath(char *buf, size_t len) +{ + return find_path(B_APP_IMAGE_SYMBOL, B_FIND_PATH_IMAGE_PATH, NULL, buf, len) == B_OK; +} + +//// Solaris +#elif defined(__sun) || defined(sun) + +bool getCurrentExecPath(char *buf, size_t len) +{ + const char *exec = getexecname(); + if (exec == NULL) + return false; + + if (strlcpy(buf, exec, len) >= len) + return false; + + return true; +} + + +// HP-UX +#elif defined(__hpux) + +bool getCurrentExecPath(char *buf, size_t len) +{ + struct pst_status psts; + + if (pstat_getproc(&psts, sizeof(psts), 0, getpid()) == -1) + return false; + + if (pstat_getpathname(buf, len, &psts.pst_fid_text) == -1) + return false; + + return true; +} + + +#else + +bool getCurrentExecPath(char *buf, size_t len) +{ + return false; +} + +#endif + + +//// Non-Windows +#if !defined(_WIN32) + +const char *getHomeOrFail() +{ + const char *home = getenv("HOME"); + // In rare cases the HOME environment variable may be unset + FATAL_ERROR_IF(!home, + "Required environment variable HOME is not set"); + return home; +} + +#endif - /* - Use platform-specific paths otherwise - */ - dstream<<"Using system-wide paths (NOT RUN_IN_PLACE)"< +bool setSystemPaths() +{ + char buf[BUFSIZ]; - const DWORD buflen = 1000; - char buf[buflen]; - DWORD len; - - // Find path of executable and set path_data relative to it - len = GetModuleFileName(GetModuleHandle(NULL), buf, buflen); - assert(len < buflen); + // Find path of executable and set path_share relative to it + FATAL_ERROR_IF(!getCurrentExecPath(buf, sizeof(buf)), + "Failed to get current executable path"); pathRemoveFile(buf, '\\'); - - // Use "./bin/../data" - path_data = std::string(buf) + "/../data"; - //path_data = std::string(buf) + "/../share/" + APPNAME; - - // Use "C:\Documents and Settings\user\Application Data\" - len = GetEnvironmentVariable("APPDATA", buf, buflen); - assert(len < buflen); - path_userdata = std::string(buf) + "/" + APPNAME; - - /* - Linux - */ - #elif defined(linux) - #include - + + std::string exepath(buf); + + // Use ".\bin\.." + path_share = exepath + "\\.."; + if (detectMSVCBuildDir(exepath)) { + // The msvc build dir schould normaly not be present if properly installed, + // but its usefull for debugging. + path_share += DIR_DELIM ".."; + } + + // Use "C:\Users\\AppData\Roaming\" + DWORD len = GetEnvironmentVariable("APPDATA", buf, sizeof(buf)); + FATAL_ERROR_IF(len == 0 || len > sizeof(buf), "Failed to get APPDATA"); + + path_user = std::string(buf) + DIR_DELIM + PROJECT_NAME_C; + return true; +} + + +//// Linux +#elif defined(__linux__) || defined(__FreeBSD__) || defined(__NetBSD__) || defined(__DragonFly__) + +bool setSystemPaths() +{ char buf[BUFSIZ]; - memset(buf, 0, BUFSIZ); - // Get path to executable - assert(readlink("/proc/self/exe", buf, BUFSIZ-1) != -1); - + + if (!getCurrentExecPath(buf, sizeof(buf))) { +#ifdef __ANDROID__ + errorstream << "Unable to read bindir "<< std::endl; +#else + FATAL_ERROR("Unable to read bindir"); +#endif + return false; + } + pathRemoveFile(buf, '/'); + std::string bindir(buf); - path_data = std::string(buf) + "/../share/" + APPNAME; - //path_data = std::string(INSTALL_PREFIX) + "/share/" + APPNAME; - - path_userdata = std::string(getenv("HOME")) + "/." + APPNAME; + // Find share directory from these. + // It is identified by containing the subdirectory "builtin". + std::list trylist; + std::string static_sharedir = STATIC_SHAREDIR; + if (!static_sharedir.empty() && static_sharedir != ".") + trylist.push_back(static_sharedir); - /* - OS X - */ - #elif defined(__APPLE__) - #include + trylist.push_back(bindir + DIR_DELIM ".." DIR_DELIM "share" + DIR_DELIM + PROJECT_NAME); + trylist.push_back(bindir + DIR_DELIM ".."); - path_userdata = std::string(getenv("HOME")) + "/Library/Application Support/" + APPNAME; - path_data = std::string("minetest-mac.app/Contents/Resources/data/"); +#ifdef __ANDROID__ + trylist.push_back(path_user); +#endif - #endif + for (std::list::const_iterator + i = trylist.begin(); i != trylist.end(); ++i) { + const std::string &trypath = *i; + if (!fs::PathExists(trypath) || + !fs::PathExists(trypath + DIR_DELIM + "builtin")) { + warningstream << "system-wide share not found at \"" + << trypath << "\""<< std::endl; + continue; + } + + // Warn if was not the first alternative + if (i != trylist.begin()) { + warningstream << "system-wide share found at \"" + << trypath << "\"" << std::endl; + } + + path_share = trypath; + break; + } + +#ifndef __ANDROID__ + path_user = std::string(getHomeOrFail()) + DIR_DELIM "." + + PROJECT_NAME; +#endif + + return true; +} + + +//// Mac OS X +#elif defined(__APPLE__) + +bool setSystemPaths() +{ + CFBundleRef main_bundle = CFBundleGetMainBundle(); + CFURLRef resources_url = CFBundleCopyResourcesDirectoryURL(main_bundle); + char path[PATH_MAX]; + if (CFURLGetFileSystemRepresentation(resources_url, + TRUE, (UInt8 *)path, PATH_MAX)) { + path_share = std::string(path); + } else { + warningstream << "Could not determine bundle resource path" << std::endl; + } + CFRelease(resources_url); + + path_user = std::string(getHomeOrFail()) + + "/Library/Application Support/" + + PROJECT_NAME; + return true; +} + + +#else + +bool setSystemPaths() +{ + path_share = STATIC_SHAREDIR; + path_user = std::string(getHomeOrFail()) + DIR_DELIM "." + + lowercase(PROJECT_NAME); + return true; +} + + +#endif + +void migrateCachePath() +{ + const std::string local_cache_path = path_user + DIR_DELIM + "cache"; + + // Delete tmp folder if it exists (it only ever contained + // a temporary ogg file, which is no longer used). + if (fs::PathExists(local_cache_path + DIR_DELIM + "tmp")) + fs::RecursiveDelete(local_cache_path + DIR_DELIM + "tmp"); + + // Bail if migration impossible + if (path_cache == local_cache_path || !fs::PathExists(local_cache_path) + || fs::PathExists(path_cache)) { + return; + } + if (!fs::Rename(local_cache_path, path_cache)) { + errorstream << "Failed to migrate local cache path " + "to system path!" << std::endl; + } +} + +void initializePaths() +{ +#if RUN_IN_PLACE + char buf[BUFSIZ]; + + infostream << "Using relative paths (RUN_IN_PLACE)" << std::endl; + + bool success = + getCurrentExecPath(buf, sizeof(buf)) || + getExecPathFromProcfs(buf, sizeof(buf)); + + if (success) { + pathRemoveFile(buf, DIR_DELIM_CHAR); + std::string execpath(buf); + + path_share = execpath + DIR_DELIM ".."; + path_user = execpath + DIR_DELIM ".."; + + if (detectMSVCBuildDir(execpath)) { + path_share += DIR_DELIM ".."; + path_user += DIR_DELIM ".."; + } + } else { + errorstream << "Failed to get paths by executable location, " + "trying cwd" << std::endl; + + if (!getCurrentWorkingDir(buf, sizeof(buf))) + FATAL_ERROR("Ran out of methods to get paths"); + size_t cwdlen = strlen(buf); + if (cwdlen >= 1 && buf[cwdlen - 1] == DIR_DELIM_CHAR) { + cwdlen--; + buf[cwdlen] = '\0'; + } + + if (cwdlen >= 4 && !strcmp(buf + cwdlen - 4, DIR_DELIM "bin")) + pathRemoveFile(buf, DIR_DELIM_CHAR); + + std::string execpath(buf); + + path_share = execpath; + path_user = execpath; + } + path_cache = path_user + DIR_DELIM + "cache"; +#else + infostream << "Using system-wide paths (NOT RUN_IN_PLACE)" << std::endl; + + if (!setSystemPaths()) + errorstream << "Failed to get one or more system-wide path" << std::endl; + + +# ifdef _WIN32 + path_cache = path_user + DIR_DELIM + "cache"; +# else + // Initialize path_cache + // First try $XDG_CACHE_HOME/PROJECT_NAME + const char *cache_dir = getenv("XDG_CACHE_HOME"); + const char *home_dir = getenv("HOME"); + if (cache_dir) { + path_cache = std::string(cache_dir) + DIR_DELIM + PROJECT_NAME; + } else if (home_dir) { + // Then try $HOME/.cache/PROJECT_NAME + path_cache = std::string(home_dir) + DIR_DELIM + ".cache" + + DIR_DELIM + PROJECT_NAME; + } else { + // If neither works, use $PATH_USER/cache + path_cache = path_user + DIR_DELIM + "cache"; + } + // Migrate cache folder to new location if possible + migrateCachePath(); +# endif // _WIN32 #endif // RUN_IN_PLACE - dstream<<"path_data = "< 32; +#elif defined(__ANDROID__) + openURIAndroid(uri); + return true; +#elif defined(__APPLE__) + const char *argv[] = {"open", uri.c_str(), NULL}; + return posix_spawnp(NULL, "open", NULL, NULL, (char**)argv, + (*_NSGetEnviron())) == 0; +#else + const char *argv[] = {"xdg-open", uri.c_str(), NULL}; + return posix_spawnp(NULL, "xdg-open", NULL, NULL, (char**)argv, environ) == 0; +#endif +} + +bool open_url(const std::string &url) +{ + if (url.substr(0, 7) != "http://" && url.substr(0, 8) != "https://") { + errorstream << "Unable to open browser as URL is missing schema: " << url << std::endl; + return false; + } + return open_uri(url); +} + +bool open_directory(const std::string &path) +{ + if (!fs::IsDir(path)) { + errorstream << "Unable to open directory as it does not exist: " << path << std::endl; + return false; + } + + return open_uri(path); +} + +// Load performance counter frequency only once at startup +#ifdef _WIN32 + +inline double get_perf_freq() +{ + // Also use this opportunity to enable high-res timers + timeBeginPeriod(1); + + LARGE_INTEGER freq; + QueryPerformanceFrequency(&freq); + return freq.QuadPart; +} + +double perf_freq = get_perf_freq(); + +#endif + +} //namespace porting