]> git.lizzy.rs Git - dragonfireclient.git/blobdiff - src/porting.cpp
Revert "Make Lint Happy"
[dragonfireclient.git] / src / porting.cpp
index ced41d4fb748083e0886440661620ece2498bf89..d902d3737048d2b49d8025351a9f24c85e34d1b8 100644 (file)
@@ -25,27 +25,35 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 
 #include "porting.h"
 
-#if defined(__FreeBSD__)
+#if defined(__FreeBSD__)  || defined(__NetBSD__) || defined(__DragonFly__)
        #include <sys/types.h>
        #include <sys/sysctl.h>
+       extern char **environ;
 #elif defined(_WIN32)
+       #include <windows.h>
+       #include <wincrypt.h>
        #include <algorithm>
+       #include <shlwapi.h>
+       #include <shellapi.h>
 #endif
 #if !defined(_WIN32)
        #include <unistd.h>
        #include <sys/utsname.h>
+       #if !defined(__ANDROID__)
+               #include <spawn.h>
+       #endif
 #endif
 #if defined(__hpux)
        #define _PSTAT64
        #include <sys/pstat.h>
 #endif
-#if !defined(_WIN32) && !defined(__APPLE__) && \
-       !defined(__ANDROID__) && !defined(SERVER)
-       #define XORG_USED
+#if defined(__ANDROID__)
+       #include "porting_android.h"
 #endif
-#ifdef XORG_USED
-       #include <X11/Xlib.h>
-       #include <X11/Xutil.h>
+#if defined(__APPLE__)
+       // For _NSGetEnviron()
+       // Related: https://gitlab.haskell.org/ghc/ghc/issues/2458
+       #include <crt_externs.h>
 #endif
 
 #include "config.h"
@@ -53,8 +61,9 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "filesys.h"
 #include "log.h"
 #include "util/string.h"
-#include "settings.h"
 #include <list>
+#include <cstdarg>
+#include <cstdio>
 
 namespace porting
 {
@@ -65,7 +74,7 @@ namespace porting
 
 bool g_killed = false;
 
-bool * signal_handler_killstatus(void)
+bool *signal_handler_killstatus()
 {
        return &g_killed;
 }
@@ -73,11 +82,16 @@ bool * signal_handler_killstatus(void)
 #if !defined(_WIN32) // POSIX
        #include <signal.h>
 
-void sigint_handler(int sig)
+void signal_handler(int sig)
 {
        if (!g_killed) {
-               dstream << "INFO: sigint_handler(): "
-                       << "Ctrl-C pressed, shutting down." << std::endl;
+               if (sig == SIGINT) {
+                       dstream << "INFO: signal_handler(): "
+                               << "Ctrl-C pressed, shutting down." << std::endl;
+               } else if (sig == SIGTERM) {
+                       dstream << "INFO: signal_handler(): "
+                               << "got SIGTERM, shutting down." << std::endl;
+               }
 
                // Comment out for less clutter when testing scripts
                /*dstream << "INFO: sigint_handler(): "
@@ -86,13 +100,14 @@ void sigint_handler(int sig)
 
                g_killed = true;
        } else {
-               (void)signal(SIGINT, SIG_DFL);
+               (void)signal(sig, SIG_DFL);
        }
 }
 
 void signal_handler_init(void)
 {
-       (void)signal(SIGINT, sigint_handler);
+       (void)signal(SIGINT, signal_handler);
+       (void)signal(SIGTERM, signal_handler);
 }
 
 #else // _WIN32
@@ -137,6 +152,7 @@ void signal_handler_init(void)
 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)
@@ -160,30 +176,38 @@ bool detectMSVCBuildDir(const std::string &path)
 {
        const char *ends[] = {
                "bin\\Release",
+               "bin\\MinSizeRel",
+               "bin\\RelWithDebInfo",
                "bin\\Debug",
                "bin\\Build",
                NULL
        };
-       return (removeStringEnd(path, ends) != "");
+       return (!removeStringEnd(path, ends).empty());
 }
 
 std::string get_sysinfo()
 {
 #ifdef _WIN32
-       OSVERSIONINFO osvi;
+
        std::ostringstream oss;
-       std::string tmp;
-       ZeroMemory(&osvi, sizeof(OSVERSIONINFO));
-       osvi.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
-       GetVersionEx(&osvi);
-       tmp = osvi.szCSDVersion;
-       std::replace(tmp.begin(), tmp.end(), ' ', '_');
-
-       oss << "Windows/" << osvi.dwMajorVersion << "."
-               << osvi.dwMinorVersion;
-       if (osvi.szCSDVersion[0])
-               oss << "-" << tmp;
-       oss << " ";
+       LPSTR filePath = new char[MAX_PATH];
+       UINT blockSize;
+       VS_FIXEDFILEINFO *fixedFileInfo;
+
+       GetSystemDirectoryA(filePath, MAX_PATH);
+       PathAppendA(filePath, "kernel32.dll");
+
+       DWORD dwVersionSize = GetFileVersionInfoSizeA(filePath, NULL);
+       LPBYTE lpVersionInfo = new BYTE[dwVersionSize];
+
+       GetFileVersionInfoA(filePath, 0, dwVersionSize, lpVersionInfo);
+       VerQueryValueA(lpVersionInfo, "\\", (LPVOID *)&fixedFileInfo, &blockSize);
+
+       oss << "Windows/"
+               << HIWORD(fixedFileInfo->dwProductVersionMS) << '.' // Major
+               << LOWORD(fixedFileInfo->dwProductVersionMS) << '.' // Minor
+               << HIWORD(fixedFileInfo->dwProductVersionLS) << ' '; // Build
+
        #ifdef _WIN64
        oss << "x86_64";
        #else
@@ -194,6 +218,9 @@ std::string get_sysinfo()
                oss << "x86";
        #endif
 
+       delete[] lpVersionInfo;
+       delete[] filePath;
+
        return oss.str();
 #else
        struct utsname osinfo;
@@ -247,7 +274,7 @@ bool getCurrentExecPath(char *buf, size_t len)
 
 
 //// Linux
-#elif defined(linux) || defined(__linux) || defined(__linux__)
+#elif defined(__linux__)
 
 bool getCurrentExecPath(char *buf, size_t len)
 {
@@ -338,6 +365,21 @@ bool getCurrentExecPath(char *buf, size_t len)
 #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
+
+
 //// Windows
 #if defined(_WIN32)
 
@@ -350,20 +392,27 @@ bool setSystemPaths()
                "Failed to get current executable path");
        pathRemoveFile(buf, '\\');
 
+       std::string exepath(buf);
+
        // Use ".\bin\.."
-       path_share = std::string(buf) + "\\..";
+       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:\Documents and Settings\user\Application Data\<PROJECT_NAME>"
+       // Use "C:\Users\<user>\AppData\Roaming\<PROJECT_NAME_C>"
        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;
+       path_user = std::string(buf) + DIR_DELIM + PROJECT_NAME_C;
        return true;
 }
 
 
 //// Linux
-#elif defined(linux) || defined(__linux)
+#elif defined(__linux__) || defined(__FreeBSD__) || defined(__NetBSD__) || defined(__DragonFly__)
 
 bool setSystemPaths()
 {
@@ -385,7 +434,7 @@ bool setSystemPaths()
        // It is identified by containing the subdirectory "builtin".
        std::list<std::string> trylist;
        std::string static_sharedir = STATIC_SHAREDIR;
-       if (static_sharedir != "" && static_sharedir != ".")
+       if (!static_sharedir.empty() && static_sharedir != ".")
                trylist.push_back(static_sharedir);
 
        trylist.push_back(bindir + DIR_DELIM ".." DIR_DELIM "share"
@@ -397,7 +446,7 @@ bool setSystemPaths()
 #endif
 
        for (std::list<std::string>::const_iterator
-                       i = trylist.begin(); i != trylist.end(); i++) {
+                       i = trylist.begin(); i != trylist.end(); ++i) {
                const std::string &trypath = *i;
                if (!fs::PathExists(trypath) ||
                        !fs::PathExists(trypath + DIR_DELIM + "builtin")) {
@@ -417,7 +466,7 @@ bool setSystemPaths()
        }
 
 #ifndef __ANDROID__
-       path_user = std::string(getenv("HOME")) + DIR_DELIM "."
+       path_user = std::string(getHomeOrFail()) + DIR_DELIM "."
                + PROJECT_NAME;
 #endif
 
@@ -441,7 +490,7 @@ bool setSystemPaths()
        }
        CFRelease(resources_url);
 
-       path_user = std::string(getenv("HOME"))
+       path_user = std::string(getHomeOrFail())
                + "/Library/Application Support/"
                + PROJECT_NAME;
        return true;
@@ -453,7 +502,7 @@ bool setSystemPaths()
 bool setSystemPaths()
 {
        path_share = STATIC_SHAREDIR;
-       path_user  = std::string(getenv("HOME")) + DIR_DELIM "."
+       path_user  = std::string(getHomeOrFail()) + DIR_DELIM "."
                + lowercase(PROJECT_NAME);
        return true;
 }
@@ -461,6 +510,25 @@ bool setSystemPaths()
 
 #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()
 {
@@ -505,201 +573,177 @@ void initializePaths()
                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;
 
-#endif
+
+#  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
 
        infostream << "Detected share path: " << path_share << std::endl;
        infostream << "Detected user path: " << path_user << std::endl;
+       infostream << "Detected cache path: " << path_cache << std::endl;
 
+#if USE_GETTEXT
        bool found_localedir = false;
-#ifdef STATIC_LOCALEDIR
-       if (STATIC_LOCALEDIR[0] && fs::PathExists(STATIC_LOCALEDIR)) {
+#  ifdef STATIC_LOCALEDIR
+       /* STATIC_LOCALEDIR may be a generalized path such as /usr/share/locale that
+        * doesn't necessarily contain our locale files, so check data path first. */
+       path_locale = getDataPath("locale");
+       if (fs::PathExists(path_locale)) {
+               found_localedir = true;
+               infostream << "Using in-place locale directory " << path_locale
+                       << " even though a static one was provided." << std::endl;
+       } else if (STATIC_LOCALEDIR[0] && fs::PathExists(STATIC_LOCALEDIR)) {
                found_localedir = true;
                path_locale = STATIC_LOCALEDIR;
-               infostream << "Using locale directory " << STATIC_LOCALEDIR << std::endl;
-       } else {
-               path_locale = getDataPath("locale");
-               if (fs::PathExists(path_locale)) {
-                       found_localedir = true;
-                       infostream << "Using in-place locale directory " << path_locale
-                               << " even though a static one was provided "
-                               << "(RUN_IN_PLACE or CUSTOM_LOCALEDIR)." << std::endl;
-               }
+               infostream << "Using static locale directory " << STATIC_LOCALEDIR
+                       << std::endl;
        }
-#else
+#  else
        path_locale = getDataPath("locale");
        if (fs::PathExists(path_locale)) {
                found_localedir = true;
        }
-#endif
+#  endif
        if (!found_localedir) {
-               errorstream << "Couldn't find a locale directory!" << std::endl;
+               warningstream << "Couldn't find a locale directory!" << std::endl;
        }
-
-}
-
-
-
-void setXorgClassHint(const video::SExposedVideoData &video_data,
-       const std::string &name)
-{
-#ifdef XORG_USED
-       if (video_data.OpenGLLinux.X11Display == NULL)
-               return;
-
-       XClassHint *classhint = XAllocClassHint();
-       classhint->res_name  = (char *)name.c_str();
-       classhint->res_class = (char *)name.c_str();
-
-       XSetClassHint((Display *)video_data.OpenGLLinux.X11Display,
-               video_data.OpenGLLinux.X11Window, classhint);
-       XFree(classhint);
-#endif
+#endif  // USE_GETTEXT
 }
 
-
 ////
-//// Video/Display Information (Client-only)
+//// OS-specific Secure Random
 ////
 
-#ifndef SERVER
-
-static irr::IrrlichtDevice *device;
+#ifdef WIN32
 
-void initIrrlicht(irr::IrrlichtDevice *device_)
+bool secure_rand_fill_buf(void *buf, size_t len)
 {
-       device = device_;
-}
-
-v2u32 getWindowSize()
-{
-       return device->getVideoDriver()->getScreenSize();
-}
-
-
-std::vector<core::vector3d<u32> > getSupportedVideoModes()
-{
-       IrrlichtDevice *nulldevice = createDevice(video::EDT_NULL);
-       sanity_check(nulldevice != NULL);
-
-       std::vector<core::vector3d<u32> > mlist;
-       video::IVideoModeList *modelist = nulldevice->getVideoModeList();
-
-       u32 num_modes = modelist->getVideoModeCount();
-       for (u32 i = 0; i != num_modes; i++) {
-               core::dimension2d<u32> mode_res = modelist->getVideoModeResolution(i);
-               s32 mode_depth = modelist->getVideoModeDepth(i);
-               mlist.push_back(core::vector3d<u32>(mode_res.Width, mode_res.Height, mode_depth));
-       }
-
-       nulldevice->drop();
-
-       return mlist;
-}
+       HCRYPTPROV wctx;
 
-std::vector<irr::video::E_DRIVER_TYPE> getSupportedVideoDrivers()
-{
-       std::vector<irr::video::E_DRIVER_TYPE> drivers;
-
-       for (int i = 0; i != irr::video::EDT_COUNT; i++) {
-               if (irr::IrrlichtDevice::isDriverSupported((irr::video::E_DRIVER_TYPE)i))
-                       drivers.push_back((irr::video::E_DRIVER_TYPE)i);
-       }
-
-       return drivers;
-}
-
-const char *getVideoDriverName(irr::video::E_DRIVER_TYPE type)
-{
-       static const char *driver_ids[] = {
-               "null",
-               "software",
-               "burningsvideo",
-               "direct3d8",
-               "direct3d9",
-               "opengl",
-               "ogles1",
-               "ogles2",
-       };
+       if (!CryptAcquireContext(&wctx, NULL, NULL, PROV_RSA_FULL, CRYPT_VERIFYCONTEXT))
+               return false;
 
-       return driver_ids[type];
+       CryptGenRandom(wctx, len, (BYTE *)buf);
+       CryptReleaseContext(wctx, 0);
+       return true;
 }
 
+#else
 
-const char *getVideoDriverFriendlyName(irr::video::E_DRIVER_TYPE type)
+bool secure_rand_fill_buf(void *buf, size_t len)
 {
-       static const char *driver_names[] = {
-               "NULL Driver",
-               "Software Renderer",
-               "Burning's Video",
-               "Direct3D 8",
-               "Direct3D 9",
-               "OpenGL",
-               "OpenGL ES1",
-               "OpenGL ES2",
-       };
+       // N.B.  This function checks *only* for /dev/urandom, because on most
+       // common OSes it is non-blocking, whereas /dev/random is blocking, and it
+       // is exceptionally uncommon for there to be a situation where /dev/random
+       // exists but /dev/urandom does not.  This guesswork is necessary since
+       // random devices are not covered by any POSIX standard...
+       FILE *fp = fopen("/dev/urandom", "rb");
+       if (!fp)
+               return false;
 
-       return driver_names[type];
+       bool success = fread(buf, len, 1, fp) == 1;
+
+       fclose(fp);
+       return success;
 }
 
-#      ifndef __ANDROID__
-#              ifdef XORG_USED
+#endif
 
-static float calcDisplayDensity()
+void attachOrCreateConsole()
 {
-       const char *current_display = getenv("DISPLAY");
-
-       if (current_display != NULL) {
-               Display *x11display = XOpenDisplay(current_display);
-
-               if (x11display != NULL) {
-                       /* try x direct */
-                       float dpi_height = floor(DisplayHeight(x11display, 0) /
-                                                       (DisplayHeightMM(x11display, 0) * 0.039370) + 0.5);
-                       float dpi_width = floor(DisplayWidth(x11display, 0) /
-                                                       (DisplayWidthMM(x11display, 0) * 0.039370) + 0.5);
-
-                       XCloseDisplay(x11display);
-
-                       return std::max(dpi_height,dpi_width) / 96.0;
-               }
+#ifdef _WIN32
+       static bool consoleAllocated = false;
+       const bool redirected = (_fileno(stdout) == -2 || _fileno(stdout) == -1); // If output is redirected to e.g a file
+       if (!consoleAllocated && redirected && (AttachConsole(ATTACH_PARENT_PROCESS) || AllocConsole())) {
+               freopen("CONOUT$", "w", stdout);
+               freopen("CONOUT$", "w", stderr);
+               consoleAllocated = true;
        }
-
-       /* return manually specified dpi */
-       return g_settings->getFloat("screen_dpi")/96.0;
+#endif
 }
 
+int mt_snprintf(char *buf, const size_t buf_size, const char *fmt, ...)
+{
+       // https://msdn.microsoft.com/en-us/library/bt7tawza.aspx
+       //  Many of the MSVC / Windows printf-style functions do not support positional
+       //  arguments (eg. "%1$s"). We just forward the call to vsnprintf for sane
+       //  platforms, but defer to _vsprintf_p on MSVC / Windows.
+       // https://github.com/FFmpeg/FFmpeg/blob/5ae9fa13f5ac640bec113120d540f70971aa635d/compat/msvcrt/snprintf.c#L46
+       //  _vsprintf_p has to be shimmed with _vscprintf_p on -1 (for an example see
+       //  above FFmpeg link).
+       va_list args;
+       va_start(args, fmt);
+#ifndef _MSC_VER
+       int c = vsnprintf(buf, buf_size, fmt, args);
+#else  // _MSC_VER
+       int c = _vsprintf_p(buf, buf_size, fmt, args);
+       if (c == -1)
+               c = _vscprintf_p(fmt, args);
+#endif // _MSC_VER
+       va_end(args);
+       return c;
+}
+
+bool openURL(const std::string &url)
+{
+       if ((url.substr(0, 7) != "http://" && url.substr(0, 8) != "https://") ||
+                       url.find_first_of("\r\n") != std::string::npos) {
+               errorstream << "Invalid url: " << url << std::endl;
+               return false;
+       }
 
-float getDisplayDensity()
-{
-       static float cached_display_density = calcDisplayDensity();
-       return cached_display_density;
+#if defined(_WIN32)
+       return (intptr_t)ShellExecuteA(NULL, NULL, url.c_str(), NULL, NULL, SW_SHOWNORMAL) > 32;
+#elif defined(__ANDROID__)
+       openURLAndroid(url);
+       return true;
+#elif defined(__APPLE__)
+       const char *argv[] = {"open", url.c_str(), NULL};
+       return posix_spawnp(NULL, "open", NULL, NULL, (char**)argv,
+               (*_NSGetEnviron())) == 0;
+#else
+       const char *argv[] = {"xdg-open", url.c_str(), NULL};
+       return posix_spawnp(NULL, "xdg-open", NULL, NULL, (char**)argv, environ) == 0;
+#endif
 }
 
+// Load performance counter frequency only once at startup
+#ifdef _WIN32
 
-#              else // XORG_USED
-float getDisplayDensity()
+inline double get_perf_freq()
 {
-       return g_settings->getFloat("screen_dpi")/96.0;
+       LARGE_INTEGER freq;
+       QueryPerformanceFrequency(&freq);
+       return freq.QuadPart;
 }
-#              endif // XORG_USED
-
-v2u32 getDisplaySize()
-{
-       IrrlichtDevice *nulldevice = createDevice(video::EDT_NULL);
 
-       core::dimension2d<u32> deskres = nulldevice->getVideoModeList()->getDesktopResolution();
-       nulldevice -> drop();
+double perf_freq = get_perf_freq();
 
-       return deskres;
-}
-#      endif // __ANDROID__
-#endif // SERVER
+#endif
 
 } //namespace porting
-