radiant/environment.cpp

   1 /*
   2    Copyright (C) 2001-2006, William Joseph.
   3    All Rights Reserved.
   4
   5    This file is part of GtkRadiant.
   6
   7    GtkRadiant 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    GtkRadiant 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 GtkRadiant; if not, write to the Free Software
  19    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20  */
  21
  22 #include "environment.h"
  23 #include "globaldefs.h"
  24
  25 #include "stream/textstream.h"
  26 #include "string/string.h"
  27 #include "stream/stringstream.h"
  28 #include "debugging/debugging.h"
  29 #include "os/path.h"
  30 #include "os/file.h"
  31 #include "cmdlib.h"
  32
  33 int g_argc;
  34 char const** g_argv;
  35
  36 void args_init( int argc, char const* argv[] ){
  37         int i, j, k;
  38
  39         for ( i = 1; i < argc; i++ )
  40         {
  41                 for ( k = i; k < argc; k++ )
  42                 {
  43                         if ( argv[k] != 0 ) {
  44                                 break;
  45                         }
  46                 }
  47
  48                 if ( k > i ) {
  49                         k -= i;
  50                         for ( j = i + k; j < argc; j++ )
  51                         {
  52                                 argv[j - k] = argv[j];
  53                         }
  54                         argc -= k;
  55                 }
  56         }
  57
  58         g_argc = argc;
  59         g_argv = argv;
  60 }
  61
  62 char const *gamedetect_argv_buffer[1024];
  63
  64 void gamedetect_found_game( char const *game, char *path ){
  65         int argc;
  66         static char buf[128];
  67
  68         if ( g_argv == gamedetect_argv_buffer ) {
  69                 return;
  70         }
  71
  72         globalOutputStream() << "Detected game " << game << " in " << path << "\n";
  73
  74         sprintf( buf, "-%s-EnginePath", game );
  75         argc = 0;
  76         gamedetect_argv_buffer[argc++] = "-global-gamefile";
  77         gamedetect_argv_buffer[argc++] = game;
  78         gamedetect_argv_buffer[argc++] = buf;
  79         gamedetect_argv_buffer[argc++] = path;
  80         if ( (size_t) ( argc + g_argc ) >= sizeof( gamedetect_argv_buffer ) / sizeof( *gamedetect_argv_buffer ) - 1 ) {
  81                 g_argc = sizeof( gamedetect_argv_buffer ) / sizeof( *gamedetect_argv_buffer ) - g_argc - 1;
  82         }
  83         memcpy( gamedetect_argv_buffer + 4, g_argv, sizeof( *gamedetect_argv_buffer ) * g_argc );
  84         g_argc += argc;
  85         g_argv = gamedetect_argv_buffer;
  86 }
  87
  88 bool gamedetect_check_game( char const *gamefile, const char *checkfile1, const char *checkfile2, char *buf /* must have 64 bytes free after bufpos */, int bufpos ){
  89         buf[bufpos] = '/';
  90
  91         strcpy( buf + bufpos + 1, checkfile1 );
  92         globalOutputStream() << "Checking for a game file in " << buf << "\n";
  93         if ( !file_exists( buf ) ) {
  94                 return false;
  95         }
  96
  97         if ( checkfile2 ) {
  98                 strcpy( buf + bufpos + 1, checkfile2 );
  99                 globalOutputStream() << "Checking for a game file in " << buf << "\n";
 100                 if ( !file_exists( buf ) ) {
 101                         return false;
 102                 }
 103         }
 104
 105         buf[bufpos + 1] = 0;
 106         gamedetect_found_game( gamefile, buf );
 107         return true;
 108 }
 109
 110 void gamedetect(){
 111         // if we're inside a Nexuiz install
 112         // default to nexuiz.game (unless the user used an option to inhibit this)
 113         bool nogamedetect = false;
 114         int i;
 115         for ( i = 1; i < g_argc - 1; ++i )
 116         {
 117                 if ( g_argv[i][0] == '-' ) {
 118                         if ( !strcmp( g_argv[i], "-gamedetect" ) ) {
 119                                 nogamedetect = !strcmp( g_argv[i + 1], "false" );
 120                         }
 121                         ++i;
 122                 }
 123         }
 124         if ( !nogamedetect ) {
 125                 static char buf[1024 + 64];
 126                 strncpy( buf, environment_get_app_path(), sizeof( buf ) );
 127                 buf[sizeof( buf ) - 1 - 64] = 0;
 128                 if ( !strlen( buf ) ) {
 129                         return;
 130                 }
 131
 132                 char *p = buf + strlen( buf ) - 1; // point directly on the slash of get_app_path
 133                 while ( p != buf )
 134                 {
 135                         // TODO add more games to this
 136
 137                         // try to detect Nexuiz installs
 138 #if GDEF_OS_WINDOWS
 139                         if ( gamedetect_check_game( "nexuiz.game", "data/common-spog.pk3", "nexuiz.exe", buf, p - buf ) )
 140 #elif GDEF_OS_MACOS
 141                         if ( gamedetect_check_game( "nexuiz.game", "data/common-spog.pk3", "Nexuiz.app/Contents/Info.plist", buf, p - buf ) )
 142 #elif GDEF_OS_LINUX
 143                         if ( gamedetect_check_game( "nexuiz.game", "data/common-spog.pk3", "nexuiz-linux-glx.sh", buf, p - buf ) )
 144 #else
 145                         if ( gamedetect_check_game( "nexuiz.game", "data/common-spog.pk3", NULL, buf, p - buf ) )
 146 #endif
 147                         { return; }
 148
 149                         // try to detect Quetoo installs
 150                         if ( gamedetect_check_game( "quetoo.game", "default/icons/quetoo.png", NULL, buf, p - buf ) ) {
 151                                 return;
 152                         }
 153
 154                         // try to detect Warsow installs
 155                         if ( gamedetect_check_game( "warsow.game", "basewsw/dedicated_autoexec.cfg", NULL, buf, p - buf ) ) {
 156                                 return;
 157                         }
 158
 159                         // we found nothing
 160                         // go backwards
 161                         --p;
 162                         while ( p != buf && *p != '/' && *p != '\\' )
 163                                 --p;
 164                 }
 165         }
 166 }
 167
 168 namespace
 169 {
 170 CopiedString home_path;
 171 CopiedString app_path;
 172         CopiedString lib_path;
 173         CopiedString data_path;
 174 }
 175
 176 const char* environment_get_home_path(){
 177         return home_path.c_str();
 178 }
 179
 180 const char* environment_get_app_path(){
 181         return app_path.c_str();
 182 }
 183
 184
 185 const char *environment_get_lib_path()
 186 {
 187         return lib_path.c_str();
 188 }
 189
 190 const char *environment_get_data_path()
 191 {
 192         return data_path.c_str();
 193 }
 194
 195 bool portable_app_setup(){
 196         StringOutputStream confdir( 256 );
 197         confdir << app_path.c_str() << "settings/";
 198         if ( file_is_directory( confdir.c_str() ) ) {
 199                 home_path = confdir.c_str();
 200                 return true;
 201         }
 202         return false;
 203 }
 204
 205 #if GDEF_OS_POSIX
 206
 207 #include <stdlib.h>
 208 #include <pwd.h>
 209 #include <unistd.h>
 210
 211 #include <glib.h>
 212
 213 const char* LINK_NAME =
 214 #if GDEF_OS_LINUX
 215         "/proc/self/exe"
 216 #else // FreeBSD and OSX
 217         "/proc/curproc/file"
 218 #endif
 219 ;
 220
 221 /// brief Returns the filename of the executable belonging to the current process, or 0 if not found.
 222 char const* getexename( char *buf ){
 223         /* Now read the symbolic link */
 224         int ret = readlink( LINK_NAME, buf, PATH_MAX );
 225
 226         if ( ret == -1 ) {
 227                 globalOutputStream() << "getexename: falling back to argv[0]: " << makeQuoted( g_argv[0] );
 228                 const char* path = realpath( g_argv[0], buf );
 229                 if ( path == 0 ) {
 230                         /* In case of an error, leave the handling up to the caller */
 231                         return "";
 232                 }
 233         }
 234
 235         /* Ensure proper NUL termination */
 236         buf[ret] = 0;
 237
 238         /* delete the program name */
 239         *( strrchr( buf, '/' ) ) = '\0';
 240
 241         // NOTE: we build app path with a trailing '/'
 242         // it's a general convention in Radiant to have the slash at the end of directories
 243         if ( buf[strlen( buf ) - 1] != '/' ) {
 244                 strcat( buf, "/" );
 245         }
 246
 247         return buf;
 248 }
 249
 250 void environment_init( int argc, char const* argv[] ){
 251         // Give away unnecessary root privileges.
 252         // Important: must be done before calling gtk_init().
 253         char *loginname;
 254         struct passwd *pw;
 255         seteuid( getuid() );
 256         if ( geteuid() == 0 && ( loginname = getlogin() ) != 0 &&
 257                  ( pw = getpwnam( loginname ) ) != 0 ) {
 258                 setuid( pw->pw_uid );
 259         }
 260
 261         args_init( argc, argv );
 262
 263         {
 264                 char real[PATH_MAX];
 265                 app_path = getexename( real );
 266                 ASSERT_MESSAGE( !string_empty( app_path.c_str() ), "failed to deduce app path" );
 267         }
 268
 269         {
 270                 StringOutputStream buffer;
 271                 buffer << app_path.c_str() << "../lib/" << RADIANT_BASENAME << "/";
 272                 if ( file_is_directory( buffer.c_str() ) ) {
 273                         lib_path = buffer.c_str();
 274                 }
 275                 else {
 276                         lib_path = app_path.c_str();
 277                 }
 278         }
 279
 280         {
 281                 StringOutputStream buffer;
 282                 buffer << app_path.c_str() << "../share/" << RADIANT_BASENAME << "/";
 283                 if ( file_is_directory( buffer.c_str() ) ) {
 284                         data_path = buffer.c_str();
 285                 }
 286                 else {
 287                         data_path = app_path.c_str();
 288                 }
 289         }
 290
 291         if ( !portable_app_setup() ) {
 292                 // this is used on both Linux and macOS
 293                 // but a macOS specific code may be written instead
 294                 StringOutputStream home( 256 );
 295                 home << DirectoryCleaned(g_get_user_config_dir()) << "/" << RADIANT_BASENAME << "/";
 296                 // first create ~/.config
 297                 // since it may be missing on brand new home directory
 298                 Q_mkdir( g_get_user_config_dir() );
 299                 // then create ~/.config/netradiant
 300                 Q_mkdir( home.c_str() );
 301                 home_path = home.c_str();
 302         }
 303         gamedetect();
 304 }
 305
 306 #elif GDEF_OS_WINDOWS
 307
 308 #include <windows.h>
 309
 310 void environment_init( int argc, char const* argv[] ){
 311         args_init( argc, argv );
 312
 313         {
 314                 // get path to the editor
 315                 char filename[MAX_PATH + 1];
 316                 GetModuleFileName( 0, filename, MAX_PATH );
 317                 char* last_separator = strrchr( filename, '\\' );
 318                 if ( last_separator != 0 ) {
 319                         *( last_separator + 1 ) = '\0';
 320                 }
 321                 else
 322                 {
 323                         filename[0] = '\0';
 324                 }
 325                 StringOutputStream app( 256 );
 326                 app << PathCleaned( filename );
 327                 app_path = app.c_str();
 328
 329                 lib_path = app_path;
 330                 data_path = app_path;
 331         }
 332
 333         if ( !portable_app_setup() ) {
 334                 char *appdata = getenv( "APPDATA" );
 335                 StringOutputStream home( 256 );
 336                 home << PathCleaned( appdata );
 337                 home << "/NetRadiantSettings/";
 338                 Q_mkdir( home.c_str() );
 339                 home_path = home.c_str();
 340         }
 341         gamedetect();
 342 }
 343
 344 #else
 345 #error "unsupported platform"
 346 #endif