#include <common/c_internal.h>
#include "content/subgames.h"
#include "constants.h"
#include "porting.h"
#include "filesys.h"
#include "settings.h"
#include "log.h"
#include "util/strfnd.h"
#include "map_settings_manager.h"
#include "util/string.h"
#include "exceptions.h"
#define MAX_WORLD_NAMES 100
#define LEGACY_GAMEID "minetest"
namespace
{
bool getGameConfig(const std::string &game_path, Settings &conf)
{
std::string conf_path = game_path + DIR_DELIM + "minetest.conf";
return conf.readConfigFile(conf_path.c_str());
}
std::string normalizeGameId(std::string_view id)
{
static const char *ends[] = {"_game", nullptr};
auto shorter = removeStringEnd(id, ends);
return std::string(shorter.empty() ? id : shorter);
}
std::unordered_set<std::string> getAliasesFromSettings(const Settings &conf)
{
std::unordered_set<std::string> aliases;
if (!conf.exists("aliases"))
return aliases;
std::vector<std::string> aliases_raw = str_split(conf.get("aliases"), ',');
for (const std::string &alias : aliases_raw)
aliases.insert(normalizeGameId(trim(alias)));
return aliases;
}
std::string getSubgamePathEnv()
{
static bool has_warned = false;
if (const char *path = getenv("LUANTI_GAME_PATH"))
return std::string(path);
if (const char *path = getenv("MINETEST_GAME_PATH")) {
if (!has_warned) {
warningstream << "MINETEST_GAME_PATH is deprecated, use LUANTI_GAME_PATH instead."
<< std::endl;
has_warned = true;
}
return std::string(path);
}
if (const char *path = getenv("MINETEST_SUBGAME_PATH")) {
if (!has_warned) {
warningstream << "MINETEST_SUBGAME_PATH is deprecated, use LUANTI_GAME_PATH instead."
<< std::endl;
has_warned = true;
}
return std::string(path);
}
return "";
}
std::string getWorldPathEnv()
{
static bool has_warned = false;
if (const char *path = getenv("LUANTI_WORLD_PATH"))
return std::string(path);
if (const char *path = getenv("MINETEST_WORLD_PATH")) {
if (!has_warned) {
warningstream << "MINETEST_WORLD_PATH is deprecated, use LUANTI_WORLD_PATH instead."
<< std::endl;
has_warned = true;
}
return std::string(path);
}
return "";
}
}
void SubgameSpec::checkAndLog() const
{
auto handling_mode = get_deprecated_handling_mode();
if (!deprecation_msgs.empty() && handling_mode != DeprecatedHandlingMode::Ignore) {
std::ostringstream os;
os << "Game " << title << " at " << path << ":" << std::endl;
for (auto msg : deprecation_msgs)
os << "\t" << msg << std::endl;
if (handling_mode == DeprecatedHandlingMode::Error)
throw ModError(os.str());
else
warningstream << os.str();
}
}
struct GameFindPath
{
std::string path;
bool user_specific;
std::unordered_set<std::string> aliases;
GameFindPath(const std::string &path, bool user_specific) :
path(path), user_specific(user_specific)
{
}
GameFindPath(const std::string &path, bool user_specific, std::unordered_set<std::string>&& aliases) :
path(path), user_specific(user_specific), aliases(aliases)
{
}
};
using GamePathMap = std::unordered_map<std::string, GameFindPath>;
static GamePathMap getAvailableGamePaths()
{
GamePathMap gamepaths;
std::vector<GameFindPath> game_search_paths{
{porting::path_share + DIR_DELIM + "games", false},
{porting::path_user + DIR_DELIM + "games", true}
};
Strfnd search_paths(getSubgamePathEnv());
while (!search_paths.at_end())
game_search_paths.emplace_back(search_paths.next(PATH_DELIM), false);
for (const GameFindPath &search_path : game_search_paths) {
auto dirlist = fs::GetDirListing(search_path.path);
for (const fs::DirListNode &dln : dirlist) {
if (!dln.dir)
continue;
Settings conf;
const std::string game_path = search_path.path + DIR_DELIM + dln.name;
if (!conf.readConfigFile((game_path + DIR_DELIM "game.conf").c_str()))
continue;
gamepaths.try_emplace(normalizeGameId(dln.name),
game_path, search_path.user_specific, getAliasesFromSettings(conf)
);
}
}
return gamepaths;
}
static SubgameSpec getSubgameSpec(const std::string &game_id,
const std::string &game_path,
const std::unordered_map<std::string, std::string> &mods_paths)
{
const auto gamemods_path = game_path + DIR_DELIM + "mods";
const std::string conf_path = game_path + DIR_DELIM + "game.conf";
Settings conf;
conf.readConfigFile(conf_path.c_str());
std::string game_title;
if (conf.exists("title"))
game_title = conf.get("title");
else if (conf.exists("name"))
game_title = conf.get("name");
else
game_title = game_id;
std::string game_author;
if (conf.exists("author"))
game_author = conf.get("author");
int game_release = 0;
if (conf.exists("release"))
game_release = conf.getS32("release");
std::string first_mod;
if (conf.exists("first_mod"))
first_mod = conf.get("first_mod");
std::string last_mod;
if (conf.exists("last_mod"))
last_mod = conf.get("last_mod");
auto aliases = getAliasesFromSettings(conf);
SubgameSpec spec(game_id, game_path, gamemods_path, mods_paths, game_title,
game_author, game_release, first_mod, last_mod, aliases);
if (conf.exists("name") && !conf.exists("title"))
spec.deprecation_msgs.push_back("\"name\" setting in game.conf is deprecated, please use \"title\" instead");
return spec;
}
std::set<std::string> getAvailableGameIds()
{
GamePathMap gamepaths = getAvailableGamePaths();
std::set<std::string> gameids;
for (auto &&p : gamepaths)
gameids.insert(std::move(p.first));
return gameids;
}
std::vector<SubgameSpec> getAvailableGames()
{
std::vector<SubgameSpec> specs;
std::set<std::string> gameids = getAvailableGameIds();
specs.reserve(gameids.size());
for (const auto &gameid : gameids)
specs.push_back(findSubgame(gameid));
return specs;
}
SubgameSpec findSubgame(const std::string &id)
{
if (id.empty())
return SubgameSpec();
std::string idv = normalizeGameId(id);
GamePathMap gamepaths = getAvailableGamePaths();
auto found = gamepaths.find(idv);
if (found == gamepaths.end()) {
for (auto it = gamepaths.begin(); it != gamepaths.end(); ++it) {
if (it->second.aliases.find(idv) != it->second.aliases.end()) {
found = it;
break;
}
}
}
if (found == gamepaths.end())
return SubgameSpec();
const GameFindPath &data = found->second;
const std::string &game_path = data.path;
bool user_game = data.user_specific;
const std::string &share = porting::path_share;
const std::string &user = porting::path_user;
std::unordered_map<std::string, std::string> mods_paths;
mods_paths["mods"] = user + DIR_DELIM + "mods";
if (!user_game && user != share)
mods_paths["share"] = share + DIR_DELIM + "mods";
for (const std::string &mod_path : getEnvModPaths()) {
mods_paths[fs::AbsolutePath(mod_path)] = mod_path;
}
return getSubgameSpec(found->first, game_path, mods_paths);
}
SubgameSpec findWorldSubgame(const std::string &world_path)
{
std::string world_gameid = getWorldGameId(world_path, true);
std::string world_gamepath = world_path + DIR_DELIM + "game";
if (fs::PathExists(world_gamepath))
return getSubgameSpec(world_gameid, world_gamepath, {});
return findSubgame(world_gameid);
}
bool getWorldExists(const std::string &world_path)
{
if (world_path.empty())
return false;
return (fs::IsFile(world_path + DIR_DELIM + "map_meta.txt") ||
fs::IsFile(world_path + DIR_DELIM + "world.mt"));
}
std::string getWorldName(const std::string &world_path, const std::string &default_name)
{
std::string conf_path = world_path + DIR_DELIM + "world.mt";
Settings conf;
bool succeeded = conf.readConfigFile(conf_path.c_str());
if (!succeeded) {
return default_name;
}
if (!conf.exists("world_name"))
return default_name;
return conf.get("world_name");
}
std::string getWorldGameId(const std::string &world_path, bool can_be_legacy)
{
std::string conf_path = world_path + DIR_DELIM + "world.mt";
Settings conf;
bool succeeded = conf.readConfigFile(conf_path.c_str());
if (!succeeded) {
if (can_be_legacy) {
if (fs::PathExists(world_path + DIR_DELIM + "map_meta.txt"))
return LEGACY_GAMEID;
}
return "";
}
if (!conf.exists("gameid"))
return "";
return conf.get("gameid");
}
std::vector<WorldSpec> getAvailableWorlds()
{
std::vector<WorldSpec> worlds;
std::set<std::string> worldspaths;
Strfnd search_paths(getWorldPathEnv());
while (!search_paths.at_end())
worldspaths.insert(search_paths.next(PATH_DELIM));
worldspaths.insert(porting::path_user + DIR_DELIM + "worlds");
infostream << "Searching worlds..." << std::endl;
for (const std::string &worldspath : worldspaths) {
infostream << " In " << worldspath << ": ";
std::vector<fs::DirListNode> dirvector = fs::GetDirListing(worldspath);
for (const fs::DirListNode &dln : dirvector) {
if (!dln.dir)
continue;
std::string fullpath = worldspath + DIR_DELIM + dln.name;
std::string name = getWorldName(fullpath, dln.name);
bool can_be_legacy = true;
std::string gameid = getWorldGameId(fullpath, can_be_legacy);
WorldSpec spec(fullpath, name, gameid);
if (!spec.isValid()) {
infostream << "(invalid: " << name << ") ";
} else {
infostream << name << " ";
worlds.push_back(spec);
}
}
infostream << std::endl;
}
do {
std::string fullpath = porting::path_user + DIR_DELIM + "world";
if (!fs::PathExists(fullpath))
break;
std::string name = "Old World";
std::string gameid = getWorldGameId(fullpath, true);
WorldSpec spec(fullpath, name, gameid);
infostream << "Old world found." << std::endl;
worlds.push_back(spec);
} while (false);
infostream << worlds.size() << " found." << std::endl;
return worlds;
}
void loadGameConfAndInitWorld(const std::string &path, const std::string &name,
const SubgameSpec &gamespec, bool create_world)
{
std::string final_path = path;
if (create_world) {
int counter = 1;
while (fs::PathExists(final_path) && counter < MAX_WORLD_NAMES) {
final_path = path + "_" + std::to_string(counter);
counter++;
}
if (fs::PathExists(final_path)) {
throw BaseException("Too many similar filenames");
}
}
Settings *game_settings = Settings::getLayer(SL_GAME);
const bool new_game_settings = (game_settings == nullptr);
if (new_game_settings) {
game_settings = Settings::createLayer(SL_GAME);
}
getGameConfig(gamespec.path, *game_settings);
game_settings->removeSecureSettings();
infostream << "Initializing world at " << final_path << std::endl;
fs::CreateAllDirs(final_path);
std::string worldmt_path = final_path + DIR_DELIM "world.mt";
if (!fs::PathExists(worldmt_path)) {
Settings gameconf;
std::string gameconf_path = gamespec.path + DIR_DELIM "game.conf";
gameconf.readConfigFile(gameconf_path.c_str());
Settings conf;
conf.set("world_name", name);
conf.set("gameid", gamespec.id);
std::string backend = "sqlite3";
if (gameconf.exists("map_persistent") && !gameconf.getBool("map_persistent")) {
backend = "dummy";
}
conf.set("backend", backend);
conf.set("player_backend", "sqlite3");
conf.set("auth_backend", "sqlite3");
conf.set("mod_storage_backend", "sqlite3");
conf.setBool("creative_mode", g_settings->getBool("creative_mode"));
conf.setBool("enable_damage", g_settings->getBool("enable_damage"));
if (MAP_BLOCKSIZE != 16)
conf.set("blocksize", std::to_string(MAP_BLOCKSIZE));
if (!conf.updateConfigFile(worldmt_path.c_str())) {
throw BaseException("Failed to update world.mt");
}
}
std::string map_meta_path = final_path + DIR_DELIM + "map_meta.txt";
if (!fs::PathExists(map_meta_path)) {
MapSettingsManager mgr(map_meta_path);
mgr.setMapSetting("seed", g_settings->get("fixed_map_seed"));
mgr.makeMapgenParams();
mgr.saveMapMeta();
}
if (new_game_settings)
delete game_settings;
}
std::vector<std::string> getEnvModPaths()
{
static bool has_warned = false;
std::vector<std::string> paths;
const char *c_mod_path = nullptr;
if ((c_mod_path = getenv("LUANTI_MOD_PATH"))) {
} else if ((c_mod_path = getenv("MINETEST_MOD_PATH"))) {
if (!has_warned) {
warningstream << "MINETEST_MOD_PATH is deprecated, use LUANTI_MOD_PATH instead."
<< std::endl;
has_warned = true;
}
}
if (c_mod_path) {
Strfnd search_paths(c_mod_path);
while (!search_paths.at_end())
paths.push_back(search_paths.next(PATH_DELIM));
}
return paths;
}