playmp_controller.cpp

Go to the documentation of this file.

/*
    Copyright (C) 2006 - 2025
    by Joerg Hinrichs <joerg.hinrichs@alice-dsl.de>
    Copyright (C) 2003 by David White <dave@whitevine.net>
    Part of the Battle for Wesnoth Project https://www.wesnoth.org/
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY.
 
    See the COPYING file for more details.
*/
 
#include "playmp_controller.hpp"
 
#include "actions/undo.hpp"
#include "countdown_clock.hpp"
#include "display_chat_manager.hpp"
#include "floating_label.hpp"
#include "formula/string_utils.hpp"     // for VGETTEXT
#include "game_end_exceptions.hpp"
#include "game_initialization/playcampaign.hpp"
#include "gettext.hpp"
#include "gui/dialogs/loading_screen.hpp"
#include "gui/dialogs/simple_item_selector.hpp"
#include "hotkey/hotkey_handler_mp.hpp"
#include "log.hpp"
#include "map/label.hpp"
#include "mp_ui_alerts.hpp"
#include "preferences/preferences.hpp"
#include "replay_helper.hpp"
#include "resources.hpp"
#include "savegame.hpp"
#include "serialization/chrono.hpp"
#include "serialization/string_utils.hpp"
#include "synced_context.hpp"
#include "video.hpp" // only for faked
#include "wesnothd_connection.hpp"
#include "whiteboard/manager.hpp"
 
static lg::log_domain log_engine("engine");
static lg::log_domain log_network("network");
 
#define LOG_NG LOG_STREAM(info, log_engine)
#define DBG_NG LOG_STREAM(debug, log_engine)
#define ERR_NW LOG_STREAM(err, log_network)
 
playmp_controller::playmp_controller(const config& level, saved_game& state_of_game, mp_game_metadata* mp_info)
    : playsingle_controller(level, state_of_game)
    , network_processing_stopped_(false)
    , next_scenario_notified_(false)
    , blindfold_(*gui_, mp_info && mp_info->skip_replay_blindfolded)
    , network_reader_([this](config& cfg) { return receive_from_wesnothd(cfg); })
    , mp_info_(mp_info)
{
    // upgrade hotkey handler to the mp (network enabled) version
    hotkey_handler_.reset(new hotkey_handler(*this, saved_game_));
 
    skip_replay_ = mp_info && mp_info->skip_replay && mp_info->current_turn > turn();
 
    if(gui_->is_blindfolded() && !is_observer()) {
        blindfold_.unblind();
    }
}
 
playmp_controller::~playmp_controller()
{
}
 
void playmp_controller::start_network()
{
    network_processing_stopped_ = false;
    LOG_NG << "network processing activated again";
}
 
void playmp_controller::stop_network()
{
    network_processing_stopped_ = true;
    LOG_NG << "network processing stopped";
}
 
void playmp_controller::on_not_observer()
{
    remove_blindfold();
}
 
void playmp_controller::remove_blindfold()
{
    if(gui_->is_blindfolded()) {
        blindfold_.unblind();
        LOG_NG << "Taking off the blindfold now";
        gui_->queue_rerender();
    }
}
 
void playmp_controller::play_human_turn()
{
    LOG_NG << "playmp::play_human_turn...";
    assert(gamestate().in_phase(game_data::TURN_PLAYING));
 
    mp::ui_alerts::turn_changed(current_team().current_player());
 
    LOG_NG << "events::commands_disabled=" << events::commands_disabled;
 
    remove_blindfold();
 
    utils::optional<countdown_clock> timer;
    if(saved_game_.mp_settings().mp_countdown) {
        timer.emplace(current_team());
    }
 
    show_turn_dialog();
 
    if(undo_stack().can_undo()) {
        // If we reload a networked mp game we cannot undo moves made before the save
        // because other players already received them
        if(!current_team().auto_shroud_updates()) {
            synced_context::run_and_store("update_shroud", replay_helper::get_update_shroud());
        }
        undo_stack().clear();
    }
 
    if(!prefs::get().disable_auto_moves()) {
        execute_gotos();
    }
 
    end_turn_enable(true);
 
    while(!should_return_to_play_side()) {
        process_network_data();
        check_objectives();
        play_slice_catch();
        if(player_type_changed_) {
            // Clean undo stack if turn has to be restarted (losing control)
            if(undo_stack().can_undo()) {
                gui_->announce(_("Undoing moves not yet transmitted to the server."), font::NORMAL_COLOR);
            }
 
            while(undo_stack().can_undo()) {
                undo_stack().undo();
            }
        }
 
        if(timer) {
            bool time_left = timer->update();
            if(!time_left) {
                end_turn_requested_ = true;
            }
        }
    }
}
 
void playmp_controller::play_idle_loop()
{
    LOG_NG << "playmp::play_idle_loop...";
 
    remove_blindfold();
 
    while(!should_return_to_play_side()) {
        process_network_data();
        play_slice_catch();
        using namespace std::chrono_literals;
        std::this_thread::sleep_for(1ms); // TODO: why?
    }
}
 
void playmp_controller::wait_for_upload()
{
    send_actions();
 
    gui2::dialogs::loading_screen::display([&]() {
        gui2::dialogs::loading_screen::progress(loading_stage::next_scenario);
        while(!next_scenario_notified_ && !is_host()) {
            process_network_data();
            using namespace std::chrono_literals;
            std::this_thread::sleep_for(10ms);
            gui2::dialogs::loading_screen::spin();
        }
    });
}
 
void playmp_controller::after_human_turn()
{
    if(saved_game_.mp_settings().mp_countdown) {
        // time_left + turn_bonus + (action_bonus * number of actions done)
        auto new_time = current_team().countdown_time()
            + saved_game_.mp_settings().mp_countdown_turn_bonus
            + saved_game_.mp_settings().mp_countdown_action_bonus * current_team().action_bonus_count();
 
        new_time
            = std::min<std::chrono::milliseconds>(new_time, saved_game_.mp_settings().mp_countdown_reservoir_time);
 
        current_team().set_action_bonus_count(0);
        current_team().set_countdown_time(new_time);
 
        recorder().add_countdown_update(new_time.count(), current_side());
    }
 
    LOG_NG << "playmp::after_human_turn...";
 
    // Normal post-processing for human turns (clear undos, end the turn, etc.)
    playsingle_controller::after_human_turn();
}
 
void playmp_controller::play_network_turn()
{
    LOG_NG << "is networked...";
 
    end_turn_enable(false);
 
    while(!should_return_to_play_side()) {
        if(!network_processing_stopped_) {
            process_network_data();
            if(!mp_info_ || mp_info_->current_turn == turn()) {
                skip_replay_ = false;
            }
        }
 
        play_slice_catch();
    }
 
    LOG_NG << "finished networked...";
}
 
void playmp_controller::process_oos(const std::string& err_msg) const
{
    // Notify the server of the oos error.
    config cfg;
    config& info = cfg.add_child("info");
    info["type"] = "termination";
    info["condition"] = "out of sync";
    send_to_wesnothd(cfg);
 
    std::stringstream temp_buf;
    std::vector<std::string> err_lines = utils::split(err_msg, '\n');
    temp_buf << _("The game is out of sync, and cannot continue. There are a number of reasons this could happen: this "
                  "can occur if you or another player have modified their game settings. This may mean one of the "
                  "players is attempting to cheat. It could also be due to a bug in the game, but this is less "
                  "likely.\n\nDo you want to save an error log of your game?");
 
    if(!err_msg.empty()) {
        temp_buf << " \n \n"; // and now the "Details:"
        for(std::vector<std::string>::iterator i = err_lines.begin(); i != err_lines.end(); ++i) {
            temp_buf << *i << '\n';
        }
        temp_buf << " \n";
    }
 
    scoped_savegame_snapshot snapshot(*this);
    savegame::oos_savegame save(saved_game_, ignore_replay_errors_);
 
    save.save_game_interactive(temp_buf.str(), savegame::savegame::YES_NO);
}
 
void playmp_controller::handle_generic_event(const std::string& name)
{
    playsingle_controller::handle_generic_event(name);
}
bool playmp_controller::is_host() const
{
    return !mp_info_ || mp_info_->is_host;
}
 
void playmp_controller::do_idle_notification()
{
    gui_->get_chat_manager().add_chat_message(std::chrono::system_clock::now(), "", 0,
        _("This side is in an idle state. To proceed with the game, it must be assigned to another controller. You may "
          "use :droid, :control or :give_control for example."),
        events::chat_handler::MESSAGE_PUBLIC, false);
}
 
void playmp_controller::maybe_linger()
{
    if(replay_controller_.get() != nullptr) {
        // We have probably been using the mp "back to turn" feature
        // We continue play since we have reached the end of the replay.
        replay_controller_.reset();
    }
 
    // mouse_handler expects at least one team for linger mode to work.
    send_actions();
    assert(is_regular_game_end());
    if(!get_end_level_data().transient.linger_mode || get_teams().empty() || video::headless()) {
        if(!is_host() && gamestate().has_next_scenario()) {
            // If we continue without lingering we need to
            // make sure the host uploads the next scenario
            // before we attempt to download it.
            wait_for_upload();
        }
    } else {
        linger();
    }
    end_turn_requested_ = true;
}
 
void playmp_controller::surrender(int side_number)
{
    undo_stack().clear();
    recorder().add_surrender(side_number);
    send_actions();
}
 
void playmp_controller::receive_actions()
{
    process_network_data();
    send_actions();
}
 
 
void playmp_controller::play_slice()
{
    if(!is_replay() && !network_processing_stopped_) {
        // receive chat during animations and delay
        // But don't execute turn data during animations etc.
        process_network_data(true);
        // send_actions() makes sure that no actions that can
        // still be undone is sent.
        send_actions();
    }
 
    playsingle_controller::play_slice();
}
 
bool playmp_controller::is_networked_mp() const
{
    return mp_info_ != nullptr;
}
 
void playmp_controller::send_to_wesnothd(const config& cfg, const std::string&) const
{
    if(mp_info_ != nullptr) {
        mp_info_->connection.send_data(cfg);
    }
}
 
bool playmp_controller::receive_from_wesnothd(config& cfg) const
{
    if(mp_info_ != nullptr) {
        return mp_info_->connection.receive_data(cfg);
    } else {
        return false;
    }
}
 
void playmp_controller::process_network_data(bool unsync_only)
{
    if(!recorder().at_end()) {
        auto commandtype = get_replay_action_type(*recorder().peek_next_action());
        // the only cases where process_network_data_impl puts something on the recorder
        // without immidiately exceuting it are user choices
        if(commandtype != REPLAY_ACTION_TYPE::DEPENDENT) {
            ERR_NW << "attempting to process network data while still having data on the replay.";
        }
        return;
    } else if (next_scenario_notified_) {
        //Do nothing, Otherwise we might risk getting data that belongs to the next scenario.
        return;
    }
 
    config cfg;
    // we could replace this "if" with a "while" to process multiple actions without delay between them
    if(network_reader_.read(cfg)) {
 
        //Don't exceute the next turns actions.
        unsync_only |= gamestate().in_phase(game_data::TURN_ENDED);
        unsync_only |= is_regular_game_end();
        unsync_only |= player_type_changed_;
 
        auto res = process_network_data_impl(cfg, unsync_only);
        if(res == PROCESS_DATA_RESULT::CANNOT_HANDLE) {
            // chat_only=true, but we received a non-chat command, probably belonging to the next
            // action when we are still exceuting the previous one.
            // save the incoming data for later.
            // Note: With this approach, incoming [turn] that we cannot handle also blocks other
            // incoming data, like [change_controller].
            network_reader_.push_front(std::move(cfg));
            return;
        }
        if(next_scenario_notified_) {
            end_turn();
        }
    }
}
 
namespace
{
/** Data sent by the server in response to the ping command. */
struct ping_response
{
    explicit ping_response(const config& cfg)
        : requested_at(std::chrono::steady_clock::duration{cfg["requested_at"].to_long_long()})
        , processed_at(chrono::parse_timestamp(cfg["processed_at"]))
    {
    }
 
    std::chrono::steady_clock::time_point requested_at;
    std::chrono::system_clock::time_point processed_at;
};
 
} // namespace
 
playmp_controller::PROCESS_DATA_RESULT playmp_controller::process_network_data_impl(const config& cfg, bool chat_only)
{
    // the simple wesnothserver implementation in wesnoth was removed years ago.
    assert(cfg.all_children_count() == 1);
    assert(cfg.attribute_range().empty());
    if(!recorder().at_end())
    {
        ERR_NW << "processing network data while still having data on the replay.";
    }
 
    if (const auto message = cfg.optional_child("message"))
    {
        game_display::get_singleton()->get_chat_manager().add_chat_message(
            std::chrono::system_clock::now(),
            message.value()["sender"],
            message.value()["side"].to_int(),
            message.value()["message"],
            events::chat_handler::MESSAGE_PUBLIC,
            prefs::get().message_bell());
    }
    else if (auto whisper = cfg.optional_child("whisper") /*&& is_observer()*/)
    {
        game_display::get_singleton()->get_chat_manager().add_chat_message(
            std::chrono::system_clock::now(),
            "whisper: " + whisper["sender"].str(),
            0,
            whisper["message"],
            events::chat_handler::MESSAGE_PRIVATE,
            prefs::get().message_bell());
    }
    else if (auto observer = cfg.optional_child("observer") )
    {
        game_display::get_singleton()->get_chat_manager().add_observer(observer["name"]);
    }
    else if (auto observer_quit = cfg.optional_child("observer_quit"))
    {
        game_display::get_singleton()->get_chat_manager().remove_observer(observer_quit["name"]);
    }
    else if (cfg.has_child("leave_game")) {
        const bool has_reason = cfg.mandatory_child("leave_game").has_attribute("reason");
        throw leavegame_wesnothd_error(has_reason ? cfg.mandatory_child("leave_game")["reason"].str() : "");
    }
    else if (auto turn = cfg.optional_child("turn"))
    {
        return process_network_turn_impl(*turn, chat_only);
    }
    else if (cfg.has_child("whiteboard"))
    {
        set_scontext_unsynced scontext;
        get_whiteboard()->process_network_data(cfg);
    }
    else if (auto change = cfg.optional_child("change_controller"))
    {
        process_network_change_controller_impl(*change);
    }
    else if (auto side_drop_c = cfg.optional_child("side_drop"))
    {
        process_network_side_drop_impl(*side_drop_c);
    }
 
    // The host has ended linger mode in a campaign -> enable the "End scenario" button
    // and tell we did get the notification.
    else if (cfg.has_child("notify_next_scenario")) {
        next_scenario_notified_ = true;
    }
 
    //If this client becomes the new host, notify the play_controller object about it
    else if (cfg.has_child("host_transfer")) {
        mp_info_->is_host = true;
        if(is_linger_mode()) {
            end_turn_enable(true);
        }
    }
    else if(auto ping = cfg.optional_child("ping")) {
        auto now = std::chrono::steady_clock::now();
        ping_response packet{*ping};
 
        auto delta = std::chrono::duration_cast<std::chrono::milliseconds>(now - packet.requested_at);
        std::string msg = formatter() << "Packet roundtrip took " << delta.count() << "ms";
 
        game_display::get_singleton()->get_chat_manager().add_chat_message(
            std::chrono::system_clock::now(), "ping", 0, msg, events::chat_handler::MESSAGE_PUBLIC, prefs::get().message_bell());
    }
    else
    {
        ERR_NW << "found unknown command:\n" << cfg.debug();
    }
 
    return PROCESS_DATA_RESULT::CONTINUE;
}
 
playmp_controller::PROCESS_DATA_RESULT playmp_controller::process_network_turn_impl(const config& t, bool chat_only)
{
    //t can contain a [command] or a [upload_log]
    assert(t.all_children_count() == 1);
 
    if(auto command = t.optional_child("command")) {
        auto commandtype = get_replay_action_type(*command);
        if(chat_only && (commandtype == REPLAY_ACTION_TYPE::SYNCED || commandtype == REPLAY_ACTION_TYPE::INVALID) ) {
            return PROCESS_DATA_RESULT::CANNOT_HANDLE;
        }
        if (commandtype == REPLAY_ACTION_TYPE::SYNCED && current_team().is_local()) {
            // Executing those is better than OOS, also the server checks that other players don't send actions while it's not their turn.
            ERR_NW << "Received a synced remote user action during our own turn";
        }
    }
 
    //note, that this function might call itself recursively: do_replay -> ... -> get_user_choice -> ... -> receive_actions -> ... -> handle_turn
    recorder().add_config(t, replay::MARK_AS_SENT);
    do_replay();
    return PROCESS_DATA_RESULT::CONTINUE;
}
 
void playmp_controller::process_network_side_drop_impl(const config& side_drop_c)
{
    // Only the host receives this message when a player leaves/disconnects.
    const int  side_drop = side_drop_c["side_num"].to_int(0);
    std::size_t index = side_drop -1;
 
    player_type_changed_ |= side_drop == game_display::get_singleton()->playing_team().side();
 
    if (index >= gamestate().board_.teams().size()) {
        ERR_NW << "unknown side " << side_drop << " is dropping game";
        throw ingame_wesnothd_error("");
    }
 
    auto ctrl = side_controller::get_enum(side_drop_c["controller"].str());
    if(!ctrl) {
        ERR_NW << "unknown controller type issued from server on side drop: " << side_drop_c["controller"];
        throw ingame_wesnothd_error("");
    }
 
    if (ctrl == side_controller::type::ai) {
        gamestate().board_.side_drop_to(side_drop, *ctrl);
        return;
    }
    //null controlled side cannot be dropped because they aren't controlled by anyone.
    else if (ctrl != side_controller::type::human) {
        ERR_NW << "unknown controller type issued from server on side drop: " << side_controller::get_string(*ctrl);
        throw ingame_wesnothd_error("");
    }
 
    int action = 0;
    int first_observer_option_idx = 0;
    int control_change_options = 0;
    bool has_next_scenario = gamestate().has_next_scenario();
 
    std::vector<std::string> observers;
    std::vector<const team *> allies;
    std::vector<std::string> options;
 
    const team &tm = gamestate().board_.teams()[index];
 
    for (const team &t : gamestate().board_.teams()) {
        if (!t.is_enemy(side_drop) && !t.is_local_human() && !t.is_local_ai() && !t.is_network_ai() && !t.is_empty()
            && t.current_player() != tm.current_player()) {
            allies.push_back(&t);
        }
    }
 
    // We want to give host chance to decide what to do for side
    if (!is_linger_mode() || has_next_scenario) {
        utils::string_map t_vars;
 
        //get all allies in as options to transfer control
        for (const team *t : allies) {
            //if this is an ally of the dropping side and it is not us (choose local player
            //if you want that) and not ai or empty and if it is not the dropping side itself,
            //get this team in as well
            t_vars["player"] = t->current_player();
            options.emplace_back(VGETTEXT("Give control to their ally $player", t_vars));
            control_change_options++;
        }
 
        first_observer_option_idx = options.size();
 
        //get all observers in as options to transfer control
        for (const std::string &screen_observers : game_display::get_singleton()->observers()) {
            t_vars["player"] = screen_observers;
            options.emplace_back(VGETTEXT("Give control to observer $player", t_vars));
            observers.push_back(screen_observers);
            control_change_options++;
        }
 
        options.emplace_back(_("Replace with AI"));
        options.emplace_back(_("Replace with local player"));
        options.emplace_back(_("Set side to idle"));
        options.emplace_back(_("Save and abort game"));
 
        t_vars["player"] = tm.current_player();
        t_vars["side_drop"] = std::to_string(side_drop);
        const std::string gettext_message =  VGETTEXT("$player who controlled side $side_drop has left the game. What do you want to do?", t_vars);
        gui2::dialogs::simple_item_selector dlg("", gettext_message, options);
        dlg.set_single_button(true);
        dlg.show();
        action = dlg.selected_index();
 
        // If esc was pressed, default to setting side to idle
        if (action == -1) {
            action = control_change_options + 2;
        }
    } else {
        // Always set leaving side to idle if in linger mode and there is no next scenario
        action = 2;
    }
 
    if (action < control_change_options) {
        // Grant control to selected ally
        // Server thinks this side is ours now so in case of error transferring side we have to make local state to same as what server thinks it is.
        gamestate().board_.side_drop_to(side_drop, side_controller::type::human, side_proxy_controller::type::idle);
 
        if (action < first_observer_option_idx) {
            send_change_side_controller(side_drop, allies[action]->current_player());
        } else {
            send_change_side_controller(side_drop, observers[action - first_observer_option_idx]);
        }
    } else {
        action -= control_change_options;
 
        //make the player an AI, and redo this turn, in case
        //it was the current player's team who has just changed into
        //an AI.
        switch(action) {
            case 0:
                on_not_observer();
                gamestate().board_.side_drop_to(side_drop, side_controller::type::human, side_proxy_controller::type::ai);
 
                return;
 
            case 1:
                on_not_observer();
                gamestate().board_.side_drop_to(side_drop, side_controller::type::human, side_proxy_controller::type::human);
 
                return;
            case 2:
                gamestate().board_.side_drop_to(side_drop, side_controller::type::human, side_proxy_controller::type::idle);
 
                return;
 
            case 3:
                //The user pressed "end game". Don't throw a network error here or he will get
                //thrown back to the title screen.
                do_autosave();
                throw_quit_game_exception();
            default:
                break;
        }
    }
}
 
void playmp_controller::process_network_change_controller_impl(const config& change)
{
 
    if(change.empty()) {
        ERR_NW << "Bad [change_controller] signal from server, [change_controller] tag was empty.";
        return;
    }
 
    const int side = change["side"].to_int();
    const bool is_local = change["is_local"].to_bool();
    const std::string player = change["player"];
    const std::string controller_type = change["controller"];
    const std::size_t index = side - 1;
    if(index >= gamestate().board_.teams().size()) {
        ERR_NW << "Bad [change_controller] signal from server, side out of bounds: " << change.debug();
        return;
    }
 
    const team & tm = gamestate().board_.teams().at(index);
    const bool was_local = tm.is_local();
 
    gamestate().board_.side_change_controller(side, is_local, player, controller_type);
 
    if (!was_local && tm.is_local()) {
        on_not_observer();
    }
 
    update_viewing_player();
 
    get_whiteboard()->on_change_controller(side,tm);
 
    player_type_changed_ |= game_display::get_singleton()->playing_team().side() == side && (was_local || tm.is_local());
}
 
void playmp_controller::send_actions()
{
    if(!is_networked_mp()) {
        return;
    }
 
    get_whiteboard()->send_network_data();
 
    const bool send_everything = synced_context::is_unsynced() ? !undo_stack().can_undo() : synced_context::undo_blocked();
    const replay::DATA_TYPE data_type = send_everything ? replay::ALL_DATA : replay::NON_UNDO_DATA;
 
    config data = recorder().get_unsent_commands(data_type);
    if (!data.empty()) {
        send_to_wesnothd(config{ "turn", data});
    }
}
 
void playmp_controller::send_change_side_controller(int side, const std::string& player)
{
    config cfg;
    config& change = cfg.add_child("change_controller");
    change["side"] = side;
    change["player"] = player;
    send_to_wesnothd(cfg);
}