Source/Utils/Folders.cpp

   1 /*
   2 Copyright (C) 2003, 2010 - Wolfire Games
   3 Copyright (C) 2010-2016 - Lugaru contributors (see AUTHORS file)
   4
   5 This file is part of Lugaru.
   6
   7 Lugaru is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2 of the License, or
  10 (at your option) any later version.
  11
  12 Lugaru is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with Lugaru.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #include "Folders.hpp"
  22
  23 #include <cerrno>
  24 #include <cstdlib>
  25 #include <cstring>
  26 #include <unistd.h>
  27
  28 #if PLATFORM_UNIX
  29 #include <pwd.h>
  30 #include <sys/stat.h>
  31 #include <sys/types.h>
  32 #endif
  33
  34 #if _WIN32
  35 #include <shlobj.h> // to get paths related functions
  36 #include <windows.h>
  37 #endif
  38
  39 const std::string Folders::dataDir = DATA_DIR;
  40
  41 std::string Folders::getScreenshotDir()
  42 {
  43     std::string screenshotDir = getUserDataPath() + "/Screenshots";
  44     makeDirectory(screenshotDir);
  45     return screenshotDir;
  46 }
  47
  48 std::string Folders::getUserDataPath()
  49 {
  50     std::string userDataPath;
  51 #ifdef _WIN32
  52     char path[MAX_PATH];
  53     // %APPDATA% (%USERPROFILE%\Application Data)
  54     if (SUCCEEDED(SHGetFolderPathA(nullptr, CSIDL_APPDATA, nullptr, 0, path))) {
  55         userDataPath = std::string(path) + "/Lugaru/";
  56     } else {
  57         return dataDir;
  58     }
  59 #elif (defined(__APPLE__) && defined(__MACH__))
  60     const char* homePath = getHomeDirectory();
  61     if (homePath == NULL) {
  62         userDataPath = ".";
  63     } else {
  64         userDataPath = std::string(homePath) + "/Library/Application Support/Lugaru";
  65     }
  66 #else // Linux
  67     userDataPath = getGenericDirectory("XDG_DATA_HOME", ".local/share");
  68 #endif
  69     makeDirectory(userDataPath);
  70     return userDataPath;
  71 }
  72
  73 std::string Folders::getConfigFilePath()
  74 {
  75     std::string configFolder;
  76 #if defined(_WIN32) || (defined(__APPLE__) && defined(__MACH__))
  77     configFolder = getUserDataPath();
  78 #else // Linux
  79     configFolder = getGenericDirectory("XDG_CONFIG_HOME", ".config");
  80     makeDirectory(configFolder);
  81 #endif
  82     return configFolder + "/config.txt";
  83 }
  84
  85 #if PLATFORM_LINUX
  86 /* Generic code for XDG ENVVAR test and fallback */
  87 std::string Folders::getGenericDirectory(const char* ENVVAR, const std::string& fallback)
  88 {
  89     const char* path = getenv(ENVVAR);
  90     std::string ret;
  91     if ((path != NULL) && (strlen(path) != 0)) {
  92         ret = std::string(path) + "/lugaru";
  93     } else {
  94         const char* homedir = getHomeDirectory();
  95         if ((homedir != NULL) && (strlen(homedir) != 0)) {
  96             ret = std::string(homedir) + '/' + fallback + "/lugaru";
  97         } else {
  98             ret = ".";
  99         }
 100     }
 101     return ret;
 102 }
 103 #endif
 104
 105 #if PLATFORM_UNIX
 106 const char* Folders::getHomeDirectory()
 107 {
 108     const char* homedir = getenv("HOME");
 109     if (homedir != NULL) {
 110         return homedir;
 111     }
 112     struct passwd* pw = getpwuid(getuid());
 113     if (pw != NULL) {
 114         return pw->pw_dir;
 115     }
 116     return NULL;
 117 }
 118 #endif
 119
 120 bool Folders::makeDirectory(const std::string& path)
 121 {
 122 #ifdef _WIN32
 123     int status = CreateDirectory(path.c_str(), NULL);
 124     return ((status != 0) || (GetLastError() == ERROR_ALREADY_EXISTS));
 125 #else
 126     errno = 0;
 127     int status = mkdir(path.c_str(), S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH);
 128     return ((status == 0) || (errno == EEXIST));
 129 #endif
 130 }
 131
 132 FILE* Folders::openMandatoryFile(const std::string& filename, const char* mode)
 133 {
 134     FILE* tfile = fopen(filename.c_str(), mode);
 135     if (tfile == NULL) {
 136         throw FileNotFoundException(filename);
 137     }
 138     return tfile;
 139 }
 140
 141 bool Folders::file_exists(const std::string& filepath)
 142 {
 143     FILE* file;
 144     file = fopen(filepath.c_str(), "rb");
 145     if (file == NULL) {
 146         return false;
 147     } else {
 148         fclose(file);
 149         return true;
 150     }
 151 }