Skip to content

Commit

Permalink
MP Lobby: some cleanup to addon requirement interface
Browse files Browse the repository at this point in the history
  • Loading branch information
@Vultraz
Vultraz committed Aug 31, 2016
1 parent 7ec92eb commit 9ee7374
Show file tree
Hide file tree
Showing 3 changed files with 78 additions and 75 deletions.
125 changes: 62 additions & 63 deletions src/gui/dialogs/lobby/data.cpp
View file
Expand Up @@ -160,65 +160,6 @@ std::string make_short_name(const std::string& long_name)

} // end anonymous namespace

// local_item is either an [era] or [modification] tag, something with addon_version and addon_id.
// (These are currently added at add-on loading time in the game_config_manager.)
// It is checked whether the local item's add-on version is required for this game, and if the
// versions are compatible. If it's not, a record is made in the req_list passed as argument.
static game_info::ADDON_REQ check_addon_version_compatibility(const config& local_item, const config& game, std::vector<game_info::required_addon>& req_list)
{
if(!local_item.has_attribute("addon_id") || !local_item.has_attribute("addon_version")) {
return game_info::SATISFIED;
}

if(const config& game_req = game.find_child("addon", "id", local_item["addon_id"])) {
// Record object which we will potentially store for this check
game_info::required_addon r;
r.addon_id = local_item["addon_id"].str();

const version_info local_ver(local_item["addon_version"].str());
version_info local_min_ver(local_item.has_attribute("addon_min_version") ? local_item["addon_min_version"] : local_item["addon_version"]);
// If UMC didn't specify last compatible version, assume no backwards compatibility.
if(local_min_ver > local_ver) {
// Some sanity checking regarding min version. If the min ver doens't make sense, ignore it.
local_min_ver = local_ver;
}

const version_info remote_ver(game_req["version"].str());
version_info remote_min_ver(game_req.has_attribute("min_version") ? game_req["min_version"] : game_req["version"]);
if(remote_min_ver > remote_ver) {
remote_min_ver = remote_ver;
}

// Check if the host is too out of date to play.
if(local_min_ver > remote_ver) {
r.outcome = game_info::CANNOT_SATISFY;

utils::string_map symbols;
symbols["addon"] = r.addon_id; // TODO: Figure out how to ask the add-on manager for the user-friendly name of this add-on.
symbols["host_ver"] = remote_ver.str();
symbols["local_ver"] = local_ver.str();
r.message = vgettext("Host's version of $addon is too old: host's version $host_ver < your version $local_ver.", symbols);
req_list.push_back(r);
return r.outcome;
}

// Check if our version is too out of date to play.
if(remote_min_ver > local_ver) {
r.outcome = game_info::NEED_DOWNLOAD;

utils::string_map symbols;
symbols["addon"] = r.addon_id; // TODO: Figure out how to ask the add-on manager for the user-friendly name of this add-on.
symbols["host_ver"] = remote_ver.str();
symbols["local_ver"] = local_ver.str();
r.message = vgettext("Your version of $addon is out of date: host's version $host_ver > your version $local_ver.", symbols);
req_list.push_back(r);
return r.outcome;
}
}

return game_info::SATISFIED;
}

game_info::game_info(const config& game, const config& game_config, const std::vector<std::string>& installed_addons)
: mini_map()
, id(game["id"])
Expand Down Expand Up @@ -253,6 +194,8 @@ game_info::game_info(const config& game, const config& game_config, const std::v
, has_friends(false)
, has_ignored(false)
, display_status(NEW)
, required_addons()
, addons_outcome(SATISFIED)
{
for(const config& addon : game.child_range("addon")) {
if(addon.has_attribute("id")) {
Expand All @@ -264,7 +207,7 @@ game_info::game_info(const config& game, const config& game_config, const std::v
utils::string_map symbols;
symbols["id"] = addon["id"].str();
r.message = vgettext("Missing addon: $id", symbols);
addons.push_back(r);
required_addons.push_back(r);
if(addons_outcome == SATISFIED) {
addons_outcome = NEED_DOWNLOAD;
}
Expand All @@ -284,7 +227,7 @@ game_info::game_info(const config& game, const config& game_config, const std::v
era_short = make_short_name(era);
}

ADDON_REQ result = check_addon_version_compatibility(era_cfg, game, addons);
ADDON_REQ result = check_addon_version_compatibility(era_cfg, game);
addons_outcome = std::max(addons_outcome, result); // Elevate to most severe error level encountered so far
} else {
have_era = !game["require_era"].to_bool(true);
Expand All @@ -307,7 +250,7 @@ game_info::game_info(const config& game, const config& game_config, const std::v
have_all_mods = false;
break;
}
ADDON_REQ result = check_addon_version_compatibility(mod, game, addons);
ADDON_REQ result = check_addon_version_compatibility(mod, game);
addons_outcome = std::max(addons_outcome, result); //elevate to most severe error level encountered so far
}
}
Expand Down Expand Up @@ -370,7 +313,7 @@ game_info::game_info(const config& game, const config& game_config, const std::v
}

if((*level_cfg)["require_scenario"].to_bool(false)) {
ADDON_REQ result = check_addon_version_compatibility((*level_cfg), game, addons);
ADDON_REQ result = check_addon_version_compatibility((*level_cfg), game);
addons_outcome = std::max(addons_outcome, result); //elevate to most severe error level encountered so far
}
} else {
Expand Down Expand Up @@ -428,6 +371,62 @@ game_info::game_info(const config& game, const config& game_config, const std::v
}
}

game_info::ADDON_REQ game_info::check_addon_version_compatibility(const config& local_item, const config& game)
{
if(!local_item.has_attribute("addon_id") || !local_item.has_attribute("addon_version")) {
return SATISFIED;
}

if(const config& game_req = game.find_child("addon", "id", local_item["addon_id"])) {
required_addon r = {local_item["addon_id"].str()}; // initialize addon_id

// Local version
const version_info local_ver(local_item["addon_version"].str());
version_info local_min_ver(local_item.has_attribute("addon_min_version") ? local_item["addon_min_version"] : local_item["addon_version"]);

// If the UMC didn't specify last compatible version, assume no backwards compatibility.
// Also apply some sanity checking regarding min version; if the min ver doens't make sense, ignore it.
local_min_ver = std::min(local_min_ver, local_ver);

// Remote version
const version_info remote_ver(game_req["version"].str());
version_info remote_min_ver(game_req.has_attribute("min_version") ? game_req["min_version"] : game_req["version"]);

remote_min_ver = std::min(remote_min_ver, remote_ver);

// Check if the host is too out of date to play.
if(local_min_ver > remote_ver) {
r.outcome = CANNOT_SATISFY;

utils::string_map symbols;
symbols["addon"] = r.addon_id; // TODO: Figure out how to ask the add-on manager for the user-friendly name of this add-on.
symbols["host_ver"] = remote_ver.str();
symbols["local_ver"] = local_ver.str();
r.message = vgettext("The host's version of <i>$addon</i> is incompatible. They have version <b>$host_ver</b> while you have version <b>$local_ver</b>.", symbols);

required_addons.push_back(r);
return r.outcome;
}

// Check if our version is too out of date to play.
if(remote_min_ver > local_ver) {
r.outcome = NEED_DOWNLOAD;

utils::string_map symbols;
symbols["addon"] = r.addon_id; // TODO: Figure out how to ask the add-on manager for the user-friendly name of this add-on.
symbols["host_ver"] = remote_ver.str();
symbols["local_ver"] = local_ver.str();
r.message = vgettext("Your version of <i>$addon</i> is incompatible. You have version <b>$local_ver</b> while the host has version <b>$host_ver</b>.", symbols);

std::cerr << "right path" << std::endl;
required_addons.push_back(r);
return r.outcome;
}
}

return SATISFIED;
}

bool game_info::can_join() const
{
return have_era && have_all_mods && !started && vacant_slots > 0;
Expand Down
4 changes: 3 additions & 1 deletion src/gui/dialogs/lobby/data.hpp
View file
Expand Up @@ -192,9 +192,11 @@ struct game_info
std::string message;
};

std::vector<required_addon> addons;
std::vector<required_addon> required_addons;
ADDON_REQ addons_outcome;

ADDON_REQ check_addon_version_compatibility(const config& local_item, const config& game);

const char* display_status_string() const;

bool match_string_filter(const std::string& filter) const;
Expand Down
24 changes: 13 additions & 11 deletions src/gui/dialogs/lobby/lobby.cpp
View file
Expand Up @@ -1511,8 +1511,8 @@ void tlobby_main::join_or_observe(int idx)
static bool handle_addon_requirements_gui(CVideo& v, const std::vector<game_info::required_addon>& reqs, game_info::ADDON_REQ addon_outcome)
{
if(addon_outcome == game_info::CANNOT_SATISFY) {
std::string e_title = _("Incompatible user-made content.");
std::string err_msg = _("This game cannot be joined because the host has out-of-date add-ons which are incompatible with your version. You might suggest they update their add-ons.");
std::string e_title = _("Incompatible User-made Content.");
std::string err_msg = _("This game cannot be joined because the host has out-of-date add-ons that are incompatible with your version. You might wish to suggest that the host's add-ons be updated.");

err_msg +="\n\n";
err_msg += _("Details:");
Expand All @@ -1524,10 +1524,10 @@ static bool handle_addon_requirements_gui(CVideo& v, const std::vector<game_info
}
}
gui2::show_message(v, e_title, err_msg, gui2::tmessage::auto_close);

return false;
} else if(addon_outcome == game_info::NEED_DOWNLOAD) {
std::string e_title = _("Missing user-made content.");
std::string e_title = _("Missing User-made Content.");
std::string err_msg = _("This game requires one or more user-made addons to be installed or updated in order to join.\nDo you want to try to install them?");

err_msg +="\n\n";
Expand All @@ -1540,15 +1540,17 @@ static bool handle_addon_requirements_gui(CVideo& v, const std::vector<game_info
err_msg += "• " + a.message + "\n";

needs_download.push_back(a.addon_id);
} else if(a.outcome == game_info::CANNOT_SATISFY) {
assert(false);
}
}

assert(needs_download.size() > 0);

if(gui2::show_message(v, e_title, err_msg, gui2::tmessage::yes_no_buttons) == gui2::twindow::OK) {
if(gui2::show_message(v, e_title, err_msg, gui2::tmessage::yes_no_buttons, true) == gui2::twindow::OK) {
// Begin download session
ad_hoc_addon_fetch_session(v, needs_download);
// Evil exception throwing. Boooo.

// TODO: get rid of evil exception throwing. Boooo! In any case, this is here to reload the game config
// and the installed_addons list that the lobby has.
throw mp::lobby_reload_request_exception();

return true;
Expand Down Expand Up @@ -1581,14 +1583,14 @@ bool tlobby_main::do_game_join(int idx, bool observe)
}
}

// check whehter to try to download addons
// Prompt user to download this game's required addons if its requirements have not been met
if(game.addons_outcome != game_info::SATISFIED) {
if(game.addons.empty()) {
if(game.required_addons.empty()) {
gui2::show_error_message(window_->video(), _("Something is wrong with the addon version check database supporting the multiplayer lobby. Please report this at http://bugs.wesnoth.org."));
return false;
}

if(!handle_addon_requirements_gui(window_->video(), game.addons, game.addons_outcome)) {
if(!handle_addon_requirements_gui(window_->video(), game.required_addons, game.addons_outcome)) {
return false;
}
}
Expand Down

0 comments on commit 9ee7374

Please sign in to comment.