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