src/main.cpp

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2013 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 #include "irrlichttypes.h" // must be included before anything irrlicht, see comment in the file
  21 #include "irrlicht.h" // createDevice
  22 #include "irrlichttypes_extrabloated.h"
  23 #include "chat_interface.h"
  24 #include "debug.h"
  25 #include "unittest/test.h"
  26 #include "server.h"
  27 #include "filesys.h"
  28 #include "version.h"
  29 #include "client/game.h"
  30 #include "defaultsettings.h"
  31 #include "gettext.h"
  32 #include "log.h"
  33 #include "util/quicktune.h"
  34 #include "httpfetch.h"
  35 #include "gameparams.h"
  36 #include "database/database.h"
  37 #include "config.h"
  38 #include "player.h"
  39 #include "porting.h"
  40 #include "network/socket.h"
  41 #if USE_CURSES
  42         #include "terminal_chat_console.h"
  43 #endif
  44 #ifndef SERVER
  45 #include "gui/guiMainMenu.h"
  46 #include "client/clientlauncher.h"
  47 #include "gui/guiEngine.h"
  48 #include "gui/mainmenumanager.h"
  49 #endif
  50 #ifdef HAVE_TOUCHSCREENGUI
  51         #include "gui/touchscreengui.h"
  52 #endif
  53
  54 // for version information only
  55 extern "C" {
  56 #if USE_LUAJIT
  57         #include <luajit.h>
  58 #else
  59         #include <lua.h>
  60 #endif
  61 }
  62
  63 #if !defined(SERVER) && \
  64         (IRRLICHT_VERSION_MAJOR == 1) && \
  65         (IRRLICHT_VERSION_MINOR == 8) && \
  66         (IRRLICHT_VERSION_REVISION == 2)
  67         #error "Irrlicht 1.8.2 is known to be broken - please update Irrlicht to version >= 1.8.3"
  68 #endif
  69
  70 #define DEBUGFILE "debug.txt"
  71 #define DEFAULT_SERVER_PORT 30000
  72
  73 typedef std::map<std::string, ValueSpec> OptionList;
  74
  75 /**********************************************************************
  76  * Private functions
  77  **********************************************************************/
  78
  79 static bool get_cmdline_opts(int argc, char *argv[], Settings *cmd_args);
  80 static void set_allowed_options(OptionList *allowed_options);
  81
  82 static void print_help(const OptionList &allowed_options);
  83 static void print_allowed_options(const OptionList &allowed_options);
  84 static void print_version();
  85 static void print_worldspecs(const std::vector<WorldSpec> &worldspecs,
  86         std::ostream &os, bool print_name = true, bool print_path = true);
  87 static void print_modified_quicktune_values();
  88
  89 static void list_game_ids();
  90 static void list_worlds(bool print_name, bool print_path);
  91 static bool setup_log_params(const Settings &cmd_args);
  92 static bool create_userdata_path();
  93 static bool init_common(const Settings &cmd_args, int argc, char *argv[]);
  94 static void startup_message();
  95 static bool read_config_file(const Settings &cmd_args);
  96 static void init_log_streams(const Settings &cmd_args);
  97
  98 static bool game_configure(GameParams *game_params, const Settings &cmd_args);
  99 static void game_configure_port(GameParams *game_params, const Settings &cmd_args);
 100
 101 static bool game_configure_world(GameParams *game_params, const Settings &cmd_args);
 102 static bool get_world_from_cmdline(GameParams *game_params, const Settings &cmd_args);
 103 static bool get_world_from_config(GameParams *game_params, const Settings &cmd_args);
 104 static bool auto_select_world(GameParams *game_params);
 105 static std::string get_clean_world_path(const std::string &path);
 106
 107 static bool game_configure_subgame(GameParams *game_params, const Settings &cmd_args);
 108 static bool get_game_from_cmdline(GameParams *game_params, const Settings &cmd_args);
 109 static bool determine_subgame(GameParams *game_params);
 110
 111 static bool run_dedicated_server(const GameParams &game_params, const Settings &cmd_args);
 112 static bool migrate_map_database(const GameParams &game_params, const Settings &cmd_args);
 113
 114 /**********************************************************************/
 115
 116
 117 FileLogOutput file_log_output;
 118
 119 static OptionList allowed_options;
 120
 121 int main(int argc, char *argv[])
 122 {
 123         int retval;
 124         debug_set_exception_handler();
 125
 126         g_logger.registerThread("Main");
 127         g_logger.addOutputMaxLevel(&stderr_output, LL_ACTION);
 128
 129         Settings cmd_args;
 130         bool cmd_args_ok = get_cmdline_opts(argc, argv, &cmd_args);
 131         if (!cmd_args_ok
 132                         || cmd_args.getFlag("help")
 133                         || cmd_args.exists("nonopt1")) {
 134                 porting::attachOrCreateConsole();
 135                 print_help(allowed_options);
 136                 return cmd_args_ok ? 0 : 1;
 137         }
 138         if (cmd_args.getFlag("console"))
 139                 porting::attachOrCreateConsole();
 140
 141         if (cmd_args.getFlag("version")) {
 142                 porting::attachOrCreateConsole();
 143                 print_version();
 144                 return 0;
 145         }
 146
 147         if (!setup_log_params(cmd_args))
 148                 return 1;
 149
 150         porting::signal_handler_init();
 151
 152 #ifdef __ANDROID__
 153         porting::initAndroid();
 154         porting::initializePathsAndroid();
 155 #else
 156         porting::initializePaths();
 157 #endif
 158
 159         if (!create_userdata_path()) {
 160                 errorstream << "Cannot create user data directory" << std::endl;
 161                 return 1;
 162         }
 163
 164         // Debug handler
 165         BEGIN_DEBUG_EXCEPTION_HANDLER
 166
 167         // List gameids if requested
 168         if (cmd_args.exists("gameid") && cmd_args.get("gameid") == "list") {
 169                 list_game_ids();
 170                 return 0;
 171         }
 172
 173         // List worlds, world names, and world paths if requested
 174         if (cmd_args.exists("worldlist")) {
 175                 if (cmd_args.get("worldlist") == "name") {
 176                         list_worlds(true, false);
 177                 } else if (cmd_args.get("worldlist") == "path") {
 178                         list_worlds(false, true);
 179                 } else if (cmd_args.get("worldlist") == "both") {
 180                         list_worlds(true, true);
 181                 } else {
 182                         errorstream << "Invalid --worldlist value: "
 183                                 << cmd_args.get("worldlist") << std::endl;
 184                         return 1;
 185                 }
 186                 return 0;
 187         }
 188
 189         if (!init_common(cmd_args, argc, argv))
 190                 return 1;
 191
 192         if (g_settings->getBool("enable_console"))
 193                 porting::attachOrCreateConsole();
 194
 195 #ifndef __ANDROID__
 196         // Run unit tests
 197         if (cmd_args.getFlag("run-unittests")) {
 198 #if BUILD_UNITTESTS
 199                 return run_tests();
 200 #else
 201                 errorstream << "Unittest support is not enabled in this binary. "
 202                         << "If you want to enable it, compile project with BUILD_UNITTESTS=1 flag."
 203                         << std::endl;
 204 #endif
 205         }
 206 #endif
 207
 208         GameStartData game_params;
 209 #ifdef SERVER
 210         porting::attachOrCreateConsole();
 211         game_params.is_dedicated_server = true;
 212 #else
 213         const bool isServer = cmd_args.getFlag("server");
 214         if (isServer)
 215                 porting::attachOrCreateConsole();
 216         game_params.is_dedicated_server = isServer;
 217 #endif
 218
 219         if (!game_configure(&game_params, cmd_args))
 220                 return 1;
 221
 222         sanity_check(!game_params.world_path.empty());
 223
 224         if (game_params.is_dedicated_server)
 225                 return run_dedicated_server(game_params, cmd_args) ? 0 : 1;
 226
 227 #ifndef SERVER
 228         retval = ClientLauncher().run(game_params, cmd_args) ? 0 : 1;
 229 #else
 230         retval = 0;
 231 #endif
 232
 233         // Update configuration file
 234         if (!g_settings_path.empty())
 235                 g_settings->updateConfigFile(g_settings_path.c_str());
 236
 237         print_modified_quicktune_values();
 238
 239         // Stop httpfetch thread (if started)
 240         httpfetch_cleanup();
 241
 242         END_DEBUG_EXCEPTION_HANDLER
 243
 244         return retval;
 245 }
 246
 247
 248 /*****************************************************************************
 249  * Startup / Init
 250  *****************************************************************************/
 251
 252
 253 static bool get_cmdline_opts(int argc, char *argv[], Settings *cmd_args)
 254 {
 255         set_allowed_options(&allowed_options);
 256
 257         return cmd_args->parseCommandLine(argc, argv, allowed_options);
 258 }
 259
 260 static void set_allowed_options(OptionList *allowed_options)
 261 {
 262         allowed_options->clear();
 263
 264         allowed_options->insert(std::make_pair("help", ValueSpec(VALUETYPE_FLAG,
 265                         _("Show allowed options"))));
 266         allowed_options->insert(std::make_pair("version", ValueSpec(VALUETYPE_FLAG,
 267                         _("Show version information"))));
 268         allowed_options->insert(std::make_pair("config", ValueSpec(VALUETYPE_STRING,
 269                         _("Load configuration from specified file"))));
 270         allowed_options->insert(std::make_pair("port", ValueSpec(VALUETYPE_STRING,
 271                         _("Set network port (UDP)"))));
 272         allowed_options->insert(std::make_pair("run-unittests", ValueSpec(VALUETYPE_FLAG,
 273                         _("Run the unit tests and exit"))));
 274         allowed_options->insert(std::make_pair("map-dir", ValueSpec(VALUETYPE_STRING,
 275                         _("Same as --world (deprecated)"))));
 276         allowed_options->insert(std::make_pair("world", ValueSpec(VALUETYPE_STRING,
 277                         _("Set world path (implies local game if used with option --go)"))));
 278         allowed_options->insert(std::make_pair("worldname", ValueSpec(VALUETYPE_STRING,
 279                         _("Set world by name (implies local game if used with option --go)"))));
 280         allowed_options->insert(std::make_pair("worldlist", ValueSpec(VALUETYPE_STRING,
 281                         _("Get list of worlds ('path' lists paths, "
 282                         "'name' lists names, 'both' lists both)"))));
 283         allowed_options->insert(std::make_pair("quiet", ValueSpec(VALUETYPE_FLAG,
 284                         _("Print to console errors only"))));
 285         allowed_options->insert(std::make_pair("color", ValueSpec(VALUETYPE_STRING,
 286                         _("Coloured logs ('always', 'never' or 'auto'), defaults to 'auto'"
 287                         ))));
 288         allowed_options->insert(std::make_pair("info", ValueSpec(VALUETYPE_FLAG,
 289                         _("Print more information to console"))));
 290         allowed_options->insert(std::make_pair("verbose",  ValueSpec(VALUETYPE_FLAG,
 291                         _("Print even more information to console"))));
 292         allowed_options->insert(std::make_pair("trace", ValueSpec(VALUETYPE_FLAG,
 293                         _("Print enormous amounts of information to log and console"))));
 294         allowed_options->insert(std::make_pair("logfile", ValueSpec(VALUETYPE_STRING,
 295                         _("Set logfile path ('' = no logging)"))));
 296         allowed_options->insert(std::make_pair("gameid", ValueSpec(VALUETYPE_STRING,
 297                         _("Set gameid (\"--gameid list\" prints available ones)"))));
 298         allowed_options->insert(std::make_pair("migrate", ValueSpec(VALUETYPE_STRING,
 299                         _("Migrate from current map backend to another (Only works when using minetestserver or with --server)"))));
 300         allowed_options->insert(std::make_pair("migrate-players", ValueSpec(VALUETYPE_STRING,
 301                 _("Migrate from current players backend to another (Only works when using minetestserver or with --server)"))));
 302         allowed_options->insert(std::make_pair("migrate-auth", ValueSpec(VALUETYPE_STRING,
 303                 _("Migrate from current auth backend to another (Only works when using minetestserver or with --server)"))));
 304         allowed_options->insert(std::make_pair("terminal", ValueSpec(VALUETYPE_FLAG,
 305                         _("Feature an interactive terminal (Only works when using minetestserver or with --server)"))));
 306 #ifndef SERVER
 307         allowed_options->insert(std::make_pair("speedtests", ValueSpec(VALUETYPE_FLAG,
 308                         _("Run speed tests"))));
 309         allowed_options->insert(std::make_pair("address", ValueSpec(VALUETYPE_STRING,
 310                         _("Address to connect to. ('' = local game)"))));
 311         allowed_options->insert(std::make_pair("random-input", ValueSpec(VALUETYPE_FLAG,
 312                         _("Enable random user input, for testing"))));
 313         allowed_options->insert(std::make_pair("server", ValueSpec(VALUETYPE_FLAG,
 314                         _("Run dedicated server"))));
 315         allowed_options->insert(std::make_pair("name", ValueSpec(VALUETYPE_STRING,
 316                         _("Set player name"))));
 317         allowed_options->insert(std::make_pair("password", ValueSpec(VALUETYPE_STRING,
 318                         _("Set password"))));
 319         allowed_options->insert(std::make_pair("password-file", ValueSpec(VALUETYPE_STRING,
 320                         _("Set password from contents of file"))));
 321         allowed_options->insert(std::make_pair("go", ValueSpec(VALUETYPE_FLAG,
 322                         _("Disable main menu"))));
 323         allowed_options->insert(std::make_pair("console", ValueSpec(VALUETYPE_FLAG,
 324                 _("Starts with the console (Windows only)"))));
 325 #endif
 326
 327 }
 328
 329 static void print_help(const OptionList &allowed_options)
 330 {
 331         std::cout << _("Allowed options:") << std::endl;
 332         print_allowed_options(allowed_options);
 333 }
 334
 335 static void print_allowed_options(const OptionList &allowed_options)
 336 {
 337         for (const auto &allowed_option : allowed_options) {
 338                 std::ostringstream os1(std::ios::binary);
 339                 os1 << "  --" << allowed_option.first;
 340                 if (allowed_option.second.type != VALUETYPE_FLAG)
 341                         os1 << _(" <value>");
 342
 343                 std::cout << padStringRight(os1.str(), 30);
 344
 345                 if (allowed_option.second.help)
 346                         std::cout << allowed_option.second.help;
 347
 348                 std::cout << std::endl;
 349         }
 350 }
 351
 352 static void print_version()
 353 {
 354         std::cout << PROJECT_NAME_C " " << g_version_hash
 355                 << " (" << porting::getPlatformName() << ")" << std::endl;
 356 #ifndef SERVER
 357         std::cout << "Using Irrlicht " IRRLICHT_SDK_VERSION << std::endl;
 358 #endif
 359 #if USE_LUAJIT
 360         std::cout << "Using " << LUAJIT_VERSION << std::endl;
 361 #else
 362         std::cout << "Using " << LUA_RELEASE << std::endl;
 363 #endif
 364         std::cout << g_build_info << std::endl;
 365 }
 366
 367 static void list_game_ids()
 368 {
 369         std::set<std::string> gameids = getAvailableGameIds();
 370         for (const std::string &gameid : gameids)
 371                 std::cout << gameid <<std::endl;
 372 }
 373
 374 static void list_worlds(bool print_name, bool print_path)
 375 {
 376         std::cout << _("Available worlds:") << std::endl;
 377         std::vector<WorldSpec> worldspecs = getAvailableWorlds();
 378         print_worldspecs(worldspecs, std::cout, print_name, print_path);
 379 }
 380
 381 static void print_worldspecs(const std::vector<WorldSpec> &worldspecs,
 382         std::ostream &os, bool print_name, bool print_path)
 383 {
 384         for (const WorldSpec &worldspec : worldspecs) {
 385                 std::string name = worldspec.name;
 386                 std::string path = worldspec.path;
 387                 if (print_name && print_path) {
 388                         os << "\t" << name << "\t\t" << path << std::endl;
 389                 } else if (print_name) {
 390                         os << "\t" << name << std::endl;
 391                 } else if (print_path) {
 392                         os << "\t" << path << std::endl;
 393                 }
 394         }
 395 }
 396
 397 static void print_modified_quicktune_values()
 398 {
 399         bool header_printed = false;
 400         std::vector<std::string> names = getQuicktuneNames();
 401
 402         for (const std::string &name : names) {
 403                 QuicktuneValue val = getQuicktuneValue(name);
 404                 if (!val.modified)
 405                         continue;
 406                 if (!header_printed) {
 407                         dstream << "Modified quicktune values:" << std::endl;
 408                         header_printed = true;
 409                 }
 410                 dstream << name << " = " << val.getString() << std::endl;
 411         }
 412 }
 413
 414 static bool setup_log_params(const Settings &cmd_args)
 415 {
 416         // Quiet mode, print errors only
 417         if (cmd_args.getFlag("quiet")) {
 418                 g_logger.removeOutput(&stderr_output);
 419                 g_logger.addOutputMaxLevel(&stderr_output, LL_ERROR);
 420         }
 421
 422         // Coloured log messages (see log.h)
 423         std::string color_mode;
 424         if (cmd_args.exists("color")) {
 425                 color_mode = cmd_args.get("color");
 426 #if !defined(_WIN32)
 427         } else {
 428                 char *color_mode_env = getenv("MT_LOGCOLOR");
 429                 if (color_mode_env)
 430                         color_mode = color_mode_env;
 431 #endif
 432         }
 433         if (color_mode != "") {
 434                 if (color_mode == "auto") {
 435                         Logger::color_mode = LOG_COLOR_AUTO;
 436                 } else if (color_mode == "always") {
 437                         Logger::color_mode = LOG_COLOR_ALWAYS;
 438                 } else if (color_mode == "never") {
 439                         Logger::color_mode = LOG_COLOR_NEVER;
 440                 } else {
 441                         errorstream << "Invalid color mode: " << color_mode << std::endl;
 442                         return false;
 443                 }
 444         }
 445
 446         // If trace is enabled, enable logging of certain things
 447         if (cmd_args.getFlag("trace")) {
 448                 dstream << _("Enabling trace level debug output") << std::endl;
 449                 g_logger.setTraceEnabled(true);
 450                 dout_con_ptr = &verbosestream; // This is somewhat old
 451                 socket_enable_debug_output = true; // Sockets doesn't use log.h
 452         }
 453
 454         // In certain cases, output info level on stderr
 455         if (cmd_args.getFlag("info") || cmd_args.getFlag("verbose") ||
 456                         cmd_args.getFlag("trace") || cmd_args.getFlag("speedtests"))
 457                 g_logger.addOutput(&stderr_output, LL_INFO);
 458
 459         // In certain cases, output verbose level on stderr
 460         if (cmd_args.getFlag("verbose") || cmd_args.getFlag("trace"))
 461                 g_logger.addOutput(&stderr_output, LL_VERBOSE);
 462
 463         return true;
 464 }
 465
 466 static bool create_userdata_path()
 467 {
 468         bool success;
 469
 470 #ifdef __ANDROID__
 471         if (!fs::PathExists(porting::path_user)) {
 472                 success = fs::CreateDir(porting::path_user);
 473         } else {
 474                 success = true;
 475         }
 476 #else
 477         // Create user data directory
 478         success = fs::CreateDir(porting::path_user);
 479 #endif
 480
 481         return success;
 482 }
 483
 484 static bool init_common(const Settings &cmd_args, int argc, char *argv[])
 485 {
 486         startup_message();
 487         set_default_settings();
 488
 489         // Initialize sockets
 490         sockets_init();
 491         atexit(sockets_cleanup);
 492
 493         // Initialize g_settings
 494         Settings::createLayer(SL_GLOBAL);
 495
 496         if (!read_config_file(cmd_args))
 497                 return false;
 498
 499         init_log_streams(cmd_args);
 500
 501         // Initialize random seed
 502         srand(time(0));
 503         mysrand(time(0));
 504
 505         // Initialize HTTP fetcher
 506         httpfetch_init(g_settings->getS32("curl_parallel_limit"));
 507
 508         init_gettext(porting::path_locale.c_str(),
 509                 g_settings->get("language"), argc, argv);
 510
 511         return true;
 512 }
 513
 514 static void startup_message()
 515 {
 516         infostream << PROJECT_NAME << " " << _("with")
 517                    << " SER_FMT_VER_HIGHEST_READ="
 518                << (int)SER_FMT_VER_HIGHEST_READ << ", "
 519                << g_build_info << std::endl;
 520 }
 521
 522 static bool read_config_file(const Settings &cmd_args)
 523 {
 524         // Path of configuration file in use
 525         sanity_check(g_settings_path == "");    // Sanity check
 526
 527         if (cmd_args.exists("config")) {
 528                 bool r = g_settings->readConfigFile(cmd_args.get("config").c_str());
 529                 if (!r) {
 530                         errorstream << "Could not read configuration from \""
 531                                     << cmd_args.get("config") << "\"" << std::endl;
 532                         return false;
 533                 }
 534                 g_settings_path = cmd_args.get("config");
 535         } else {
 536                 std::vector<std::string> filenames;
 537                 filenames.push_back(porting::path_user + DIR_DELIM + "minetest.conf");
 538                 // Legacy configuration file location
 539                 filenames.push_back(porting::path_user +
 540                                 DIR_DELIM + ".." + DIR_DELIM + "minetest.conf");
 541
 542 #if RUN_IN_PLACE
 543                 // Try also from a lower level (to aid having the same configuration
 544                 // for many RUN_IN_PLACE installs)
 545                 filenames.push_back(porting::path_user +
 546                                 DIR_DELIM + ".." + DIR_DELIM + ".." + DIR_DELIM + "minetest.conf");
 547 #endif
 548
 549                 for (const std::string &filename : filenames) {
 550                         bool r = g_settings->readConfigFile(filename.c_str());
 551                         if (r) {
 552                                 g_settings_path = filename;
 553                                 break;
 554                         }
 555                 }
 556
 557                 // If no path found, use the first one (menu creates the file)
 558                 if (g_settings_path.empty())
 559                         g_settings_path = filenames[0];
 560         }
 561
 562         return true;
 563 }
 564
 565 static void init_log_streams(const Settings &cmd_args)
 566 {
 567         std::string log_filename = porting::path_user + DIR_DELIM + DEBUGFILE;
 568
 569         if (cmd_args.exists("logfile"))
 570                 log_filename = cmd_args.get("logfile");
 571
 572         g_logger.removeOutput(&file_log_output);
 573         std::string conf_loglev = g_settings->get("debug_log_level");
 574
 575         // Old integer format
 576         if (std::isdigit(conf_loglev[0])) {
 577                 warningstream << "Deprecated use of debug_log_level with an "
 578                         "integer value; please update your configuration." << std::endl;
 579                 static const char *lev_name[] =
 580                         {"", "error", "action", "info", "verbose"};
 581                 int lev_i = atoi(conf_loglev.c_str());
 582                 if (lev_i < 0 || lev_i >= (int)ARRLEN(lev_name)) {
 583                         warningstream << "Supplied invalid debug_log_level!"
 584                                 "  Assuming action level." << std::endl;
 585                         lev_i = 2;
 586                 }
 587                 conf_loglev = lev_name[lev_i];
 588         }
 589
 590         if (log_filename.empty() || conf_loglev.empty())  // No logging
 591                 return;
 592
 593         LogLevel log_level = Logger::stringToLevel(conf_loglev);
 594         if (log_level == LL_MAX) {
 595                 warningstream << "Supplied unrecognized debug_log_level; "
 596                         "using maximum." << std::endl;
 597         }
 598
 599         file_log_output.setFile(log_filename,
 600                 g_settings->getU64("debug_log_size_max") * 1000000);
 601         g_logger.addOutputMaxLevel(&file_log_output, log_level);
 602 }
 603
 604 static bool game_configure(GameParams *game_params, const Settings &cmd_args)
 605 {
 606         game_configure_port(game_params, cmd_args);
 607
 608         if (!game_configure_world(game_params, cmd_args)) {
 609                 errorstream << "No world path specified or found." << std::endl;
 610                 return false;
 611         }
 612
 613         game_configure_subgame(game_params, cmd_args);
 614
 615         return true;
 616 }
 617
 618 static void game_configure_port(GameParams *game_params, const Settings &cmd_args)
 619 {
 620         if (cmd_args.exists("port")) {
 621                 game_params->socket_port = cmd_args.getU16("port");
 622         } else {
 623                 if (game_params->is_dedicated_server)
 624                         game_params->socket_port = g_settings->getU16("port");
 625                 else
 626                         game_params->socket_port = g_settings->getU16("remote_port");
 627         }
 628
 629         if (game_params->socket_port == 0)
 630                 game_params->socket_port = DEFAULT_SERVER_PORT;
 631 }
 632
 633 static bool game_configure_world(GameParams *game_params, const Settings &cmd_args)
 634 {
 635         if (get_world_from_cmdline(game_params, cmd_args))
 636                 return true;
 637
 638         if (get_world_from_config(game_params, cmd_args))
 639                 return true;
 640
 641         return auto_select_world(game_params);
 642 }
 643
 644 static bool get_world_from_cmdline(GameParams *game_params, const Settings &cmd_args)
 645 {
 646         std::string commanded_world;
 647
 648         // World name
 649         std::string commanded_worldname;
 650         if (cmd_args.exists("worldname"))
 651                 commanded_worldname = cmd_args.get("worldname");
 652
 653         // If a world name was specified, convert it to a path
 654         if (!commanded_worldname.empty()) {
 655                 // Get information about available worlds
 656                 std::vector<WorldSpec> worldspecs = getAvailableWorlds();
 657                 bool found = false;
 658                 for (const WorldSpec &worldspec : worldspecs) {
 659                         std::string name = worldspec.name;
 660                         if (name == commanded_worldname) {
 661                                 dstream << _("Using world specified by --worldname on the "
 662                                         "command line") << std::endl;
 663                                 commanded_world = worldspec.path;
 664                                 found = true;
 665                                 break;
 666                         }
 667                 }
 668                 if (!found) {
 669                         dstream << _("World") << " '" << commanded_worldname
 670                                 << _("' not available. Available worlds:") << std::endl;
 671                         print_worldspecs(worldspecs, dstream);
 672                         return false;
 673                 }
 674
 675                 game_params->world_path = get_clean_world_path(commanded_world);
 676                 return !commanded_world.empty();
 677         }
 678
 679         if (cmd_args.exists("world"))
 680                 commanded_world = cmd_args.get("world");
 681         else if (cmd_args.exists("map-dir"))
 682                 commanded_world = cmd_args.get("map-dir");
 683         else if (cmd_args.exists("nonopt0")) // First nameless argument
 684                 commanded_world = cmd_args.get("nonopt0");
 685
 686         game_params->world_path = get_clean_world_path(commanded_world);
 687         return !commanded_world.empty();
 688 }
 689
 690 static bool get_world_from_config(GameParams *game_params, const Settings &cmd_args)
 691 {
 692         // World directory
 693         std::string commanded_world;
 694
 695         if (g_settings->exists("map-dir"))
 696                 commanded_world = g_settings->get("map-dir");
 697
 698         game_params->world_path = get_clean_world_path(commanded_world);
 699
 700         return !commanded_world.empty();
 701 }
 702
 703 static bool auto_select_world(GameParams *game_params)
 704 {
 705         // No world was specified; try to select it automatically
 706         // Get information about available worlds
 707
 708         std::vector<WorldSpec> worldspecs = getAvailableWorlds();
 709         std::string world_path;
 710
 711         // If there is only a single world, use it
 712         if (worldspecs.size() == 1) {
 713                 world_path = worldspecs[0].path;
 714                 dstream <<_("Automatically selecting world at") << " ["
 715                         << world_path << "]" << std::endl;
 716         // If there are multiple worlds, list them
 717         } else if (worldspecs.size() > 1 && game_params->is_dedicated_server) {
 718                 std::cerr << _("Multiple worlds are available.") << std::endl;
 719                 std::cerr << _("Please select one using --worldname <name>"
 720                                 " or --world <path>") << std::endl;
 721                 print_worldspecs(worldspecs, std::cerr);
 722                 return false;
 723         // If there are no worlds, automatically create a new one
 724         } else {
 725                 // This is the ultimate default world path
 726                 world_path = porting::path_user + DIR_DELIM + "worlds" +
 727                                 DIR_DELIM + "world";
 728                 infostream << "Using default world at ["
 729                            << world_path << "]" << std::endl;
 730         }
 731
 732         assert(world_path != "");       // Post-condition
 733         game_params->world_path = world_path;
 734         return true;
 735 }
 736
 737 static std::string get_clean_world_path(const std::string &path)
 738 {
 739         const std::string worldmt = "world.mt";
 740         std::string clean_path;
 741
 742         if (path.size() > worldmt.size()
 743                         && path.substr(path.size() - worldmt.size()) == worldmt) {
 744                 dstream << _("Supplied world.mt file - stripping it off.") << std::endl;
 745                 clean_path = path.substr(0, path.size() - worldmt.size());
 746         } else {
 747                 clean_path = path;
 748         }
 749         return path;
 750 }
 751
 752
 753 static bool game_configure_subgame(GameParams *game_params, const Settings &cmd_args)
 754 {
 755         bool success;
 756
 757         success = get_game_from_cmdline(game_params, cmd_args);
 758         if (!success)
 759                 success = determine_subgame(game_params);
 760
 761         return success;
 762 }
 763
 764 static bool get_game_from_cmdline(GameParams *game_params, const Settings &cmd_args)
 765 {
 766         SubgameSpec commanded_gamespec;
 767
 768         if (cmd_args.exists("gameid")) {
 769                 std::string gameid = cmd_args.get("gameid");
 770                 commanded_gamespec = findSubgame(gameid);
 771                 if (!commanded_gamespec.isValid()) {
 772                         errorstream << "Game \"" << gameid << "\" not found" << std::endl;
 773                         return false;
 774                 }
 775                 dstream << _("Using game specified by --gameid on the command line")
 776                         << std::endl;
 777                 game_params->game_spec = commanded_gamespec;
 778                 return true;
 779         }
 780
 781         return false;
 782 }
 783
 784 static bool determine_subgame(GameParams *game_params)
 785 {
 786         SubgameSpec gamespec;
 787
 788         assert(game_params->world_path != "");  // Pre-condition
 789
 790         // If world doesn't exist
 791         if (!game_params->world_path.empty()
 792                 && !getWorldExists(game_params->world_path)) {
 793                 // Try to take gamespec from command line
 794                 if (game_params->game_spec.isValid()) {
 795                         gamespec = game_params->game_spec;
 796                         infostream << "Using commanded gameid [" << gamespec.id << "]" << std::endl;
 797                 } else { // Otherwise we will be using "minetest"
 798                         gamespec = findSubgame(g_settings->get("default_game"));
 799                         infostream << "Using default gameid [" << gamespec.id << "]" << std::endl;
 800                         if (!gamespec.isValid()) {
 801                                 errorstream << "Game specified in default_game ["
 802                                             << g_settings->get("default_game")
 803                                             << "] is invalid." << std::endl;
 804                                 return false;
 805                         }
 806                 }
 807         } else { // World exists
 808                 std::string world_gameid = getWorldGameId(game_params->world_path, false);
 809                 // If commanded to use a gameid, do so
 810                 if (game_params->game_spec.isValid()) {
 811                         gamespec = game_params->game_spec;
 812                         if (game_params->game_spec.id != world_gameid) {
 813                                 warningstream << "Using commanded gameid ["
 814                                             << gamespec.id << "]" << " instead of world gameid ["
 815                                             << world_gameid << "]" << std::endl;
 816                         }
 817                 } else {
 818                         // If world contains an embedded game, use it;
 819                         // Otherwise find world from local system.
 820                         gamespec = findWorldSubgame(game_params->world_path);
 821                         infostream << "Using world gameid [" << gamespec.id << "]" << std::endl;
 822                 }
 823         }
 824
 825         if (!gamespec.isValid()) {
 826                 errorstream << "Game [" << gamespec.id << "] could not be found."
 827                             << std::endl;
 828                 return false;
 829         }
 830
 831         game_params->game_spec = gamespec;
 832         return true;
 833 }
 834
 835
 836 /*****************************************************************************
 837  * Dedicated server
 838  *****************************************************************************/
 839 static bool run_dedicated_server(const GameParams &game_params, const Settings &cmd_args)
 840 {
 841         verbosestream << _("Using world path") << " ["
 842                       << game_params.world_path << "]" << std::endl;
 843         verbosestream << _("Using gameid") << " ["
 844                       << game_params.game_spec.id << "]" << std::endl;
 845
 846         // Bind address
 847         std::string bind_str = g_settings->get("bind_address");
 848         Address bind_addr(0, 0, 0, 0, game_params.socket_port);
 849
 850         if (g_settings->getBool("ipv6_server")) {
 851                 bind_addr.setAddress((IPv6AddressBytes*) NULL);
 852         }
 853         try {
 854                 bind_addr.Resolve(bind_str.c_str());
 855         } catch (ResolveError &e) {
 856                 infostream << "Resolving bind address \"" << bind_str
 857                            << "\" failed: " << e.what()
 858                            << " -- Listening on all addresses." << std::endl;
 859         }
 860         if (bind_addr.isIPv6() && !g_settings->getBool("enable_ipv6")) {
 861                 errorstream << "Unable to listen on "
 862                             << bind_addr.serializeString()
 863                             << L" because IPv6 is disabled" << std::endl;
 864                 return false;
 865         }
 866
 867         // Database migration
 868         if (cmd_args.exists("migrate"))
 869                 return migrate_map_database(game_params, cmd_args);
 870
 871         if (cmd_args.exists("migrate-players"))
 872                 return ServerEnvironment::migratePlayersDatabase(game_params, cmd_args);
 873
 874         if (cmd_args.exists("migrate-auth"))
 875                 return ServerEnvironment::migrateAuthDatabase(game_params, cmd_args);
 876
 877         if (cmd_args.exists("terminal")) {
 878 #if USE_CURSES
 879                 bool name_ok = true;
 880                 std::string admin_nick = g_settings->get("name");
 881
 882                 name_ok = name_ok && !admin_nick.empty();
 883                 name_ok = name_ok && string_allowed(admin_nick, PLAYERNAME_ALLOWED_CHARS);
 884
 885                 if (!name_ok) {
 886                         if (admin_nick.empty()) {
 887                                 errorstream << "No name given for admin. "
 888                                         << "Please check your minetest.conf that it "
 889                                         << "contains a 'name = ' to your main admin account."
 890                                         << std::endl;
 891                         } else {
 892                                 errorstream << "Name for admin '"
 893                                         << admin_nick << "' is not valid. "
 894                                         << "Please check that it only contains allowed characters. "
 895                                         << "Valid characters are: " << PLAYERNAME_ALLOWED_CHARS_USER_EXPL
 896                                         << std::endl;
 897                         }
 898                         return false;
 899                 }
 900                 ChatInterface iface;
 901                 bool &kill = *porting::signal_handler_killstatus();
 902
 903                 try {
 904                         // Create server
 905                         Server server(game_params.world_path, game_params.game_spec,
 906                                         false, bind_addr, true, &iface);
 907
 908                         g_term_console.setup(&iface, &kill, admin_nick);
 909
 910                         g_term_console.start();
 911
 912                         server.start();
 913                         // Run server
 914                         dedicated_server_loop(server, kill);
 915                 } catch (const ModError &e) {
 916                         g_term_console.stopAndWaitforThread();
 917                         errorstream << "ModError: " << e.what() << std::endl;
 918                         return false;
 919                 } catch (const ServerError &e) {
 920                         g_term_console.stopAndWaitforThread();
 921                         errorstream << "ServerError: " << e.what() << std::endl;
 922                         return false;
 923                 }
 924
 925                 // Tell the console to stop, and wait for it to finish,
 926                 // only then leave context and free iface
 927                 g_term_console.stop();
 928                 g_term_console.wait();
 929
 930                 g_term_console.clearKillStatus();
 931         } else {
 932 #else
 933                 errorstream << "Cmd arg --terminal passed, but "
 934                         << "compiled without ncurses. Ignoring." << std::endl;
 935         } {
 936 #endif
 937                 try {
 938                         // Create server
 939                         Server server(game_params.world_path, game_params.game_spec, false,
 940                                 bind_addr, true);
 941                         server.start();
 942
 943                         // Run server
 944                         bool &kill = *porting::signal_handler_killstatus();
 945                         dedicated_server_loop(server, kill);
 946
 947                 } catch (const ModError &e) {
 948                         errorstream << "ModError: " << e.what() << std::endl;
 949                         return false;
 950                 } catch (const ServerError &e) {
 951                         errorstream << "ServerError: " << e.what() << std::endl;
 952                         return false;
 953                 }
 954         }
 955
 956         return true;
 957 }
 958
 959 static bool migrate_map_database(const GameParams &game_params, const Settings &cmd_args)
 960 {
 961         std::string migrate_to = cmd_args.get("migrate");
 962         Settings world_mt;
 963         std::string world_mt_path = game_params.world_path + DIR_DELIM + "world.mt";
 964         if (!world_mt.readConfigFile(world_mt_path.c_str())) {
 965                 errorstream << "Cannot read world.mt!" << std::endl;
 966                 return false;
 967         }
 968
 969         if (!world_mt.exists("backend")) {
 970                 errorstream << "Please specify your current backend in world.mt:"
 971                         << std::endl
 972                         << "    backend = {sqlite3|leveldb|redis|dummy|postgresql}"
 973                         << std::endl;
 974                 return false;
 975         }
 976
 977         std::string backend = world_mt.get("backend");
 978         if (backend == migrate_to) {
 979                 errorstream << "Cannot migrate: new backend is same"
 980                         << " as the old one" << std::endl;
 981                 return false;
 982         }
 983
 984         MapDatabase *old_db = ServerMap::createDatabase(backend, game_params.world_path, world_mt),
 985                 *new_db = ServerMap::createDatabase(migrate_to, game_params.world_path, world_mt);
 986
 987         u32 count = 0;
 988         time_t last_update_time = 0;
 989         bool &kill = *porting::signal_handler_killstatus();
 990
 991         std::vector<v3s16> blocks;
 992         old_db->listAllLoadableBlocks(blocks);
 993         new_db->beginSave();
 994         for (std::vector<v3s16>::const_iterator it = blocks.begin(); it != blocks.end(); ++it) {
 995                 if (kill) return false;
 996
 997                 std::string data;
 998                 old_db->loadBlock(*it, &data);
 999                 if (!data.empty()) {
1000                         new_db->saveBlock(*it, data);
1001                 } else {
1002                         errorstream << "Failed to load block " << PP(*it) << ", skipping it." << std::endl;
1003                 }
1004                 if (++count % 0xFF == 0 && time(NULL) - last_update_time >= 1) {
1005                         std::cerr << " Migrated " << count << " blocks, "
1006                                 << (100.0 * count / blocks.size()) << "% completed.\r";
1007                         new_db->endSave();
1008                         new_db->beginSave();
1009                         last_update_time = time(NULL);
1010                 }
1011         }
1012         std::cerr << std::endl;
1013         new_db->endSave();
1014         delete old_db;
1015         delete new_db;
1016
1017         actionstream << "Successfully migrated " << count << " blocks" << std::endl;
1018         world_mt.set("backend", migrate_to);
1019         if (!world_mt.updateConfigFile(world_mt_path.c_str()))
1020                 errorstream << "Failed to update world.mt!" << std::endl;
1021         else
1022                 actionstream << "world.mt updated" << std::endl;
1023
1024         return true;
1025 }