-
-
Notifications
You must be signed in to change notification settings - Fork 988
/
playmp_controller.cpp
519 lines (457 loc) · 14.5 KB
/
playmp_controller.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
/*
Copyright (C) 2006 - 2018 by Joerg Hinrichs <joerg.hinrichs@alice-dsl.de>
wesnoth playlevel 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 "display_chat_manager.hpp"
#include "floating_label.hpp"
#include "game_end_exceptions.hpp"
#include "gui/dialogs/loading_screen.hpp"
#include "gettext.hpp"
#include "hotkey/hotkey_handler_mp.hpp"
#include "log.hpp"
#include "mp_ui_alerts.hpp"
#include "playturn.hpp"
#include "preferences/general.hpp"
#include "preferences/game.hpp"
#include "game_initialization/playcampaign.hpp"
#include "resources.hpp"
#include "savegame.hpp"
#include "serialization/string_utils.hpp"
#include "whiteboard/manager.hpp"
#include "countdown_clock.hpp"
#include "synced_context.hpp"
#include "replay_helper.hpp"
#include "wesnothd_connection.hpp"
static lg::log_domain log_engine("engine");
#define LOG_NG LOG_STREAM(info, log_engine)
playmp_controller::playmp_controller(const config& level,
saved_game& state_of_game,
const ter_data_cache & tdata,
mp_campaign_info* mp_info)
: playsingle_controller(level, state_of_game, tdata, mp_info && mp_info->skip_replay)
, network_processing_stopped_(false)
, blindfold_(*gui_, mp_info && mp_info->skip_replay_blindfolded)
, mp_info_(mp_info)
{
hotkey_handler_.reset(new hotkey_handler(*this, saved_game_)); //upgrade hotkey handler to the mp (network enabled) version
//turn_data_.set_host(is_host);
turn_data_.host_transfer().attach_handler(this);
if (!mp_info || mp_info->current_turn <= turn()) {
skip_replay_ = false;
}
if (gui_->is_blindfolded() && gamestate().first_human_team_ != -1) {
blindfold_.unblind();
}
}
playmp_controller::~playmp_controller() {
//halt and cancel the countdown timer
try {
turn_data_.host_transfer().detach_handler(this);
} catch (...) {}
}
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 " << std::endl;
gui_->redraw_everything();
}
}
void playmp_controller::play_linger_turn()
{
if (is_host()) {
end_turn_enable(true);
}
while(end_turn_ == END_TURN_NONE) {
config cfg;
if(network_reader_.read(cfg)) {
if(turn_data_.process_network_data(cfg) == turn_info::PROCESS_END_LINGER)
{
end_turn();
}
}
play_slice();
}
}
void playmp_controller::play_human_turn()
{
LOG_NG << "playmp::play_human_turn...\n";
assert(!linger_);
assert(gamestate_->init_side_done());
assert(gamestate().gamedata_.phase() == game_data::PLAY);
mp_ui_alerts::turn_changed(current_team().current_player());
LOG_NG << "events::commands_disabled=" << events::commands_disabled <<"\n";
remove_blindfold();
const std::unique_ptr<countdown_clock> timer(saved_game_.mp_settings().mp_countdown
? new countdown_clock(current_team())
: nullptr);
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 (!preferences::disable_auto_moves()) {
execute_gotos();
}
end_turn_enable(true);
while(!should_return_to_play_side()) {
try {
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() )
{
font::floating_label flabel(_("Undoing moves not yet transmitted to the server."));
color_t color {255,255,255,SDL_ALPHA_OPAQUE};
flabel.set_color(color);
SDL_Rect rect = gui_->map_area();
flabel.set_position(rect.w/2, rect.h/2);
flabel.set_lifetime(2500);
flabel.set_clip_rect(rect);
font::add_floating_label(flabel);
}
while( undo_stack().can_undo() )
undo_stack().undo();
}
if(timer)
{
bool time_left = timer->update();
if(!time_left)
{
end_turn_ = END_TURN_REQUIRED;
}
}
}
catch(...)
{
turn_data_.send_data();
throw;
}
turn_data_.send_data();
}
}
void playmp_controller::play_idle_loop()
{
LOG_NG << "playmp::play_human_turn...\n";
remove_blindfold();
while (!should_return_to_play_side())
{
try
{
process_network_data();
play_slice_catch();
SDL_Delay(1);
}
catch(...)
{
turn_data_.send_data();
throw;
}
turn_data_.send_data();
}
}
void playmp_controller::set_end_scenario_button()
{
// Modify the end-turn button
if (! is_host()) {
std::shared_ptr<gui::button> btn_end = gui_->find_action_button("button-endturn");
btn_end->enable(false);
}
gui_->get_theme().refresh_title2("button-endturn", "title2");
gui_->invalidate_theme();
gui_->redraw_everything();
}
void playmp_controller::reset_end_scenario_button()
{
// revert the end-turn button text to its normal label
gui_->get_theme().refresh_title2("button-endturn", "title");
gui_->invalidate_theme();
gui_->redraw_everything();
gui_->set_game_mode(game_display::RUNNING);
}
void playmp_controller::linger()
{
LOG_NG << "beginning end-of-scenario linger\n";
linger_ = true;
// If we need to set the status depending on the completion state
// we're needed here.
gui_->set_game_mode(game_display::LINGER);
// End all unit moves
gamestate().board_.set_all_units_user_end_turn();
set_end_scenario_button();
assert(is_regular_game_end());
if ( get_end_level_data_const().transient.reveal_map ) {
// Change the view of all players and observers
// to see the whole map regardless of shroud and fog.
update_gui_to_player(gui_->viewing_team(), true);
}
bool quit;
do {
quit = true;
try {
// reimplement parts of play_side()
turn_data_.send_data();
end_turn_ = END_TURN_NONE;
play_linger_turn();
after_human_turn();
LOG_NG << "finished human turn" << std::endl;
} catch (const savegame::load_game_exception&) {
LOG_NG << "caught load-game-exception" << std::endl;
// this should not happen, the option to load a game is disabled
throw;
} catch (const leavegame_wesnothd_error& e) {
scoped_savegame_snapshot snapshot(*this);
savegame::ingame_savegame save(saved_game_, preferences::save_compression_format());
if(e.message == "") {
save.save_game_interactive(_("A network disconnection has occurred, and the game cannot continue. Do you want to save the game?"), savegame::savegame::YES_NO);
} else {
save.save_game_interactive(_("This game has been ended.\nReason: ")+e.message+_("\nDo you want to save the game?"), savegame::savegame::YES_NO);
}
throw;
} catch (const ingame_wesnothd_error&) {
LOG_NG << "caught network-error-exception" << std::endl;
quit = false;
}
} while (!quit);
reset_end_scenario_button();
LOG_NG << "ending end-of-scenario linger\n";
}
void playmp_controller::wait_for_upload()
{
// If the host is here we'll never leave since we wait for the host to
// upload the next scenario.
assert(!is_host());
config cfg;
network_reader_.set_source(playturn_network_adapter::get_source_from_config(cfg));
while(true) {
try {
const bool res =
mp_info_->connection.fetch_data_with_loading_screen(cfg, loading_stage::next_scenario);
if(res) {
if (turn_data_.process_network_data_from_reader() == turn_info::PROCESS_END_LINGER) {
break;
}
}
else
{
throw_quit_game_exception();
}
} catch(const quit_game_exception&) {
network_reader_.set_source([this](config& cfg) { return receive_from_wesnothd(cfg);});
turn_data_.send_data();
throw;
}
}
network_reader_.set_source([this](config& cfg) { return receive_from_wesnothd(cfg);});
}
void playmp_controller::after_human_turn(){
if(saved_game_.mp_settings().mp_countdown)
{
//time_left + turn_bonus + (action_bonus * number of actions done)
const int new_time_in_secs = (current_team().countdown_time() / 1000)
+ saved_game_.mp_settings().mp_countdown_turn_bonus
+ saved_game_.mp_settings().mp_countdown_action_bonus * current_team().action_bonus_count();
const int new_time = 1000 * std::min<int>(new_time_in_secs, saved_game_.mp_settings().mp_countdown_reservoir_time);
current_team().set_action_bonus_count(0);
current_team().set_countdown_time(new_time);
resources::recorder->add_countdown_update(new_time, current_side());
}
LOG_NG << "playmp::after_human_turn...\n";
// Normal post-processing for human turns (clear undos, end the turn, etc.)
playsingle_controller::after_human_turn();
//send one more time to make sure network is up-to-date.
turn_data_.send_data();
}
void playmp_controller::play_network_turn(){
LOG_NG << "is networked...\n";
end_turn_enable(false);
turn_data_.send_data();
while(end_turn_ != END_TURN_SYNCED && !is_regular_game_end() && !player_type_changed_)
{
if (!network_processing_stopped_) {
process_network_data();
if (!mp_info_ || mp_info_->current_turn == turn()) {
skip_replay_ = false;
}
}
play_slice_catch();
if (!network_processing_stopped_){
turn_data_.send_data();
}
}
LOG_NG << "finished networked...\n";
}
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){
turn_data_.send_data();
if (name == "ai_user_interact")
{
playsingle_controller::handle_generic_event(name);
turn_data_.send_data();
}
else if (name == "ai_gamestate_changed")
{
turn_data_.send_data();
}
else if (name == "host_transfer"){
assert(mp_info_);
mp_info_->is_host = true;
if (linger_){
end_turn_enable(true);
gui_->invalidate_theme();
}
}
}
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::time(nullptr), "", 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()
{
// mouse_handler expects at least one team for linger mode to work.
assert(is_regular_game_end());
if (!get_end_level_data_const().transient.linger_mode || gamestate().board_.teams().empty() || gui_->video().faked()) {
const bool has_next_scenario = !gamestate().gamedata_.next_scenario().empty() && gamestate().gamedata_.next_scenario() != "null";
if(!is_host() && 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();
}
}
void playmp_controller::surrender(int side_number) {
undo_stack().clear();
resources::recorder->add_surrender(side_number);
turn_data_.send_data();
}
void playmp_controller::pull_remote_choice()
{
turn_info::PROCESS_DATA_RESULT res = turn_data_.sync_network();
assert(res != turn_info::PROCESS_END_TURN);
if(res == turn_info::PROCESS_END_LINGER) {
// Probably some bad OOS, but there is currently no way to recover from this.
throw ingame_wesnothd_error("");
}
if(res == turn_info::PROCESS_RESTART_TURN)
{
player_type_changed_ = true;
}
}
void playmp_controller::send_user_choice()
{
turn_data_.send_data();
}
void playmp_controller::play_slice(bool is_delay_enabled)
{
if(!linger_ && !is_replay()) {
//receive chat during animations and delay
process_network_data(true);
//cannot use turn_data_.send_data() here.
replay_sender_.sync_non_undoable();
}
playsingle_controller::play_slice(is_delay_enabled);
}
void playmp_controller::process_network_data(bool chat_only)
{
if(end_turn_ == END_TURN_SYNCED || is_regular_game_end() || player_type_changed_) {
return;
}
turn_info::PROCESS_DATA_RESULT res = turn_info::PROCESS_CONTINUE;
config cfg;
if(!resources::recorder->at_end()) {
res = turn_info::replay_to_process_data_result(do_replay());
}
else if(network_reader_.read(cfg)) {
res = turn_data_.process_network_data(cfg, chat_only);
}
if (res == turn_info::PROCESS_CANNOT_HANDLE) {
network_reader_.push_front(std::move(cfg));
}
else if (res == turn_info::PROCESS_RESTART_TURN) {
player_type_changed_ = true;
}
else if (res == turn_info::PROCESS_END_TURN) {
end_turn_ = END_TURN_SYNCED;
}
else if (res == turn_info::PROCESS_END_LEVEL) {
}
else if (res == turn_info::PROCESS_END_LINGER) {
replay::process_error("Received unexpected next_scenario during the game");
}
}
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;
}
}