src/porting.cpp

   1 /*
   2 Minetest-c55
   3 Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 /*
  21         Random portability stuff
  22
  23         See comments in porting.h
  24 */
  25
  26 #if defined(linux)
  27         #include <unistd.h>
  28 #elif defined(__APPLE__)
  29         #include <unistd.h>
  30         #include <mach-o/dyld.h>
  31 #elif defined(__FreeBSD__)
  32         #include <unistd.h>
  33         #include <sys/types.h>
  34         #include <sys/sysctl.h>
  35 #endif
  36
  37 #include "porting.h"
  38 #include "config.h"
  39 #include "debug.h"
  40 #include "filesys.h"
  41 #include "log.h"
  42 #include "util/string.h"
  43 #include <list>
  44
  45 #ifdef __APPLE__
  46         #include "CoreFoundation/CoreFoundation.h"
  47 #endif
  48
  49 namespace porting
  50 {
  51
  52 /*
  53         Signal handler (grabs Ctrl-C on POSIX systems)
  54 */
  55
  56 bool g_killed = false;
  57
  58 bool * signal_handler_killstatus(void)
  59 {
  60         return &g_killed;
  61 }
  62
  63 #if !defined(_WIN32) // POSIX
  64         #include <signal.h>
  65
  66 void sigint_handler(int sig)
  67 {
  68         if(g_killed == false)
  69         {
  70                 dstream<<DTIME<<"INFO: sigint_handler(): "
  71                                 <<"Ctrl-C pressed, shutting down."<<std::endl;
  72
  73                 // Comment out for less clutter when testing scripts
  74                 /*dstream<<DTIME<<"INFO: sigint_handler(): "
  75                                 <<"Printing debug stacks"<<std::endl;
  76                 debug_stacks_print();*/
  77
  78                 g_killed = true;
  79         }
  80         else
  81         {
  82                 (void)signal(SIGINT, SIG_DFL);
  83         }
  84 }
  85
  86 void signal_handler_init(void)
  87 {
  88         (void)signal(SIGINT, sigint_handler);
  89 }
  90
  91 #else // _WIN32
  92         #include <signal.h>
  93
  94         BOOL WINAPI event_handler(DWORD sig)
  95         {
  96                 switch(sig)
  97                 {
  98                 case CTRL_C_EVENT:
  99                 case CTRL_CLOSE_EVENT:
 100                 case CTRL_LOGOFF_EVENT:
 101                 case CTRL_SHUTDOWN_EVENT:
 102
 103                         if(g_killed == false)
 104                         {
 105                                 dstream<<DTIME<<"INFO: event_handler(): "
 106                                                 <<"Ctrl+C, Close Event, Logoff Event or Shutdown Event, shutting down."<<std::endl;
 107                                 // Comment out for less clutter when testing scripts
 108                                 /*dstream<<DTIME<<"INFO: event_handler(): "
 109                                                 <<"Printing debug stacks"<<std::endl;
 110                                 debug_stacks_print();*/
 111
 112                                 g_killed = true;
 113                         }
 114                         else
 115                         {
 116                                 (void)signal(SIGINT, SIG_DFL);
 117                         }
 118
 119                         break;
 120                 case CTRL_BREAK_EVENT:
 121                         break;
 122                 }
 123
 124                 return TRUE;
 125         }
 126
 127 void signal_handler_init(void)
 128 {
 129         SetConsoleCtrlHandler( (PHANDLER_ROUTINE)event_handler,TRUE);
 130 }
 131
 132 #endif
 133
 134 /*
 135         Path mangler
 136 */
 137
 138 // Default to RUN_IN_PLACE style relative paths
 139 std::string path_share = "..";
 140 std::string path_user = "..";
 141
 142 std::string getDataPath(const char *subpath)
 143 {
 144         return path_share + DIR_DELIM + subpath;
 145 }
 146
 147 void pathRemoveFile(char *path, char delim)
 148 {
 149         // Remove filename and path delimiter
 150         int i;
 151         for(i = strlen(path)-1; i>=0; i--)
 152         {
 153                 if(path[i] == delim)
 154                         break;
 155         }
 156         path[i] = 0;
 157 }
 158
 159 bool detectMSVCBuildDir(char *c_path)
 160 {
 161         std::string path(c_path);
 162         const char *ends[] = {"bin\\Release", "bin\\Build", NULL};
 163         return (removeStringEnd(path, ends) != "");
 164 }
 165
 166 void initializePaths()
 167 {
 168 #if RUN_IN_PLACE
 169         /*
 170                 Use relative paths if RUN_IN_PLACE
 171         */
 172
 173         infostream<<"Using relative paths (RUN_IN_PLACE)"<<std::endl;
 174
 175         /*
 176                 Windows
 177         */
 178         #if defined(_WIN32)
 179
 180         const DWORD buflen = 1000;
 181         char buf[buflen];
 182         DWORD len;
 183
 184         // Find path of executable and set path_share relative to it
 185         len = GetModuleFileName(GetModuleHandle(NULL), buf, buflen);
 186         assert(len < buflen);
 187         pathRemoveFile(buf, '\\');
 188
 189         if(detectMSVCBuildDir(buf)){
 190                 infostream<<"MSVC build directory detected"<<std::endl;
 191                 path_share = std::string(buf) + "\\..\\..";
 192                 path_user = std::string(buf) + "\\..\\..";
 193         }
 194         else{
 195                 path_share = std::string(buf) + "\\..";
 196                 path_user = std::string(buf) + "\\..";
 197         }
 198
 199         /*
 200                 Linux
 201         */
 202         #elif defined(linux)
 203
 204         char buf[BUFSIZ];
 205         memset(buf, 0, BUFSIZ);
 206         // Get path to executable
 207         assert(readlink("/proc/self/exe", buf, BUFSIZ-1) != -1);
 208
 209         pathRemoveFile(buf, '/');
 210
 211         path_share = std::string(buf) + "/..";
 212         path_user = std::string(buf) + "/..";
 213
 214         /*
 215                 OS X
 216         */
 217         #elif defined(__APPLE__)
 218
 219         //https://developer.apple.com/library/mac/#documentation/Darwin/Reference/ManPages/man3/dyld.3.html
 220         //TODO: Test this code
 221         char buf[BUFSIZ];
 222         uint32_t len = sizeof(buf);
 223         assert(_NSGetExecutablePath(buf, &len) != 0);
 224
 225         pathRemoveFile(buf, '/');
 226
 227         path_share = std::string(buf) + "/..";
 228         path_user = std::string(buf) + "/..";
 229
 230         /*
 231                 FreeBSD
 232         */
 233         #elif defined(__FreeBSD__)
 234
 235         int mib[4];
 236         char buf[BUFSIZ];
 237         size_t len = sizeof(buf);
 238
 239         mib[0] = CTL_KERN;
 240         mib[1] = KERN_PROC;
 241         mib[2] = KERN_PROC_PATHNAME;
 242         mib[3] = -1;
 243         assert(sysctl(mib, 4, buf, &len, NULL, 0) != -1);
 244
 245         pathRemoveFile(buf, '/');
 246
 247         path_share = std::string(buf) + "/..";
 248         path_user = std::string(buf) + "/..";
 249
 250         #else
 251
 252         //TODO: Get path of executable. This assumes working directory is bin/
 253         dstream<<"WARNING: Relative path not properly supported on this platform"
 254                         <<std::endl;
 255         path_share = std::string("..");
 256         path_user = std::string("..");
 257
 258         #endif
 259
 260 #else // RUN_IN_PLACE
 261
 262         /*
 263                 Use platform-specific paths otherwise
 264         */
 265
 266         infostream<<"Using system-wide paths (NOT RUN_IN_PLACE)"<<std::endl;
 267
 268         /*
 269                 Windows
 270         */
 271         #if defined(_WIN32)
 272
 273         const DWORD buflen = 1000;
 274         char buf[buflen];
 275         DWORD len;
 276
 277         // Find path of executable and set path_share relative to it
 278         len = GetModuleFileName(GetModuleHandle(NULL), buf, buflen);
 279         assert(len < buflen);
 280         pathRemoveFile(buf, '\\');
 281
 282         // Use ".\bin\.."
 283         path_share = std::string(buf) + "\\..";
 284
 285         // Use "C:\Documents and Settings\user\Application Data\<PROJECT_NAME>"
 286         len = GetEnvironmentVariable("APPDATA", buf, buflen);
 287         assert(len < buflen);
 288         path_user = std::string(buf) + DIR_DELIM + PROJECT_NAME;
 289
 290         /*
 291                 Linux
 292         */
 293         #elif defined(linux)
 294
 295         // Get path to executable
 296         std::string bindir = "";
 297         {
 298                 char buf[BUFSIZ];
 299                 memset(buf, 0, BUFSIZ);
 300                 assert(readlink("/proc/self/exe", buf, BUFSIZ-1) != -1);
 301                 pathRemoveFile(buf, '/');
 302                 bindir = buf;
 303         }
 304
 305         // Find share directory from these.
 306         // It is identified by containing the subdirectory "builtin".
 307         std::list<std::string> trylist;
 308         std::string static_sharedir = STATIC_SHAREDIR;
 309         if(static_sharedir != "" && static_sharedir != ".")
 310                 trylist.push_back(static_sharedir);
 311         trylist.push_back(bindir + "/../share/" + PROJECT_NAME);
 312         trylist.push_back(bindir + "/..");
 313
 314         for(std::list<std::string>::const_iterator i = trylist.begin();
 315                         i != trylist.end(); i++)
 316         {
 317                 const std::string &trypath = *i;
 318                 if(!fs::PathExists(trypath) || !fs::PathExists(trypath + "/builtin")){
 319                         dstream<<"WARNING: system-wide share not found at \""
 320                                         <<trypath<<"\""<<std::endl;
 321                         continue;
 322                 }
 323                 // Warn if was not the first alternative
 324                 if(i != trylist.begin()){
 325                         dstream<<"WARNING: system-wide share found at \""
 326                                         <<trypath<<"\""<<std::endl;
 327                 }
 328                 path_share = trypath;
 329                 break;
 330         }
 331
 332         path_user = std::string(getenv("HOME")) + "/." + PROJECT_NAME;
 333
 334         /*
 335                 OS X
 336         */
 337         #elif defined(__APPLE__)
 338
 339     // Code based on
 340     // http://stackoverflow.com/questions/516200/relative-paths-not-working-in-xcode-c
 341     CFBundleRef main_bundle = CFBundleGetMainBundle();
 342     CFURLRef resources_url = CFBundleCopyResourcesDirectoryURL(main_bundle);
 343     char path[PATH_MAX];
 344     if(CFURLGetFileSystemRepresentation(resources_url, TRUE, (UInt8 *)path, PATH_MAX))
 345         {
 346                 dstream<<"Bundle resource path: "<<path<<std::endl;
 347                 //chdir(path);
 348                 path_share = std::string(path) + "/share";
 349         }
 350         else
 351     {
 352         // error!
 353                 dstream<<"WARNING: Could not determine bundle resource path"<<std::endl;
 354     }
 355     CFRelease(resources_url);
 356
 357         path_user = std::string(getenv("HOME")) + "/Library/Application Support/" + PROJECT_NAME;
 358
 359         #elif defined(__FreeBSD__)
 360
 361         path_share = STATIC_SHAREDIR;
 362         path_user = std::string(getenv("HOME")) + "/." + PROJECT_NAME;
 363
 364         #endif
 365
 366 #endif // RUN_IN_PLACE
 367 }
 368
 369 } //namespace porting
 370