-
-
Notifications
You must be signed in to change notification settings - Fork 988
/
savegame.cpp
1119 lines (953 loc) · 32.1 KB
/
savegame.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
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
Copyright (C) 2003 - 2014 by Jörg Hinrichs, refactored from various
places formerly created by David White <dave@whitevine.net>
Part of the Battle for Wesnoth Project http://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 <boost/assign/list_of.hpp>
#include <boost/iostreams/filter/gzip.hpp>
#include "savegame.hpp"
#include "dialogs.hpp" //FIXME: get rid of this as soon as the two remaining dialogs are moved to gui2
#include "format_time_summary.hpp"
#include "formula_string_utils.hpp"
#include "game_display.hpp"
#include "game_end_exceptions.hpp"
#include "game_preferences.hpp"
#include "gettext.hpp"
#include "gui/dialogs/game_load.hpp"
#include "gui/dialogs/game_save.hpp"
#include "gui/dialogs/message.hpp"
#include "gui/dialogs/campaign_difficulty.hpp"
#include "gui/dialogs/transient_message.hpp"
#include "gui/widgets/settings.hpp"
#include "gui/widgets/window.hpp"
#include "log.hpp"
#include "map.hpp"
#include "map_label.hpp"
#include "persist_manager.hpp"
#include "replay.hpp"
#include "resources.hpp"
#include "serialization/binary_or_text.hpp"
#include "serialization/parser.hpp"
#include "statistics.hpp"
//#include "unit.hpp"
#include "unit_id.hpp"
#include "version.hpp"
#include <boost/foreach.hpp>
static lg::log_domain log_engine("engine");
#define LOG_SAVE LOG_STREAM(info, log_engine)
#define ERR_SAVE LOG_STREAM(err, log_engine)
static lg::log_domain log_enginerefac("enginerefac");
#define LOG_RG LOG_STREAM(info, log_enginerefac)
#ifdef _WIN32
#ifdef INADDR_ANY
#undef INADDR_ANY
#endif
#ifdef INADDR_BROADCAST
#undef INADDR_BROADCAST
#endif
#ifdef INADDR_NONE
#undef INADDR_NONE
#endif
#include <windows.h>
/**
* conv_ansi_utf8()
* - Convert a string between ANSI encoding (for Windows filename) and UTF-8
* string &name
* - filename to be converted
* bool a2u
* - if true, convert the string from ANSI to UTF-8.
* - if false, reverse. (convert it from UTF-8 to ANSI)
*/
void conv_ansi_utf8(std::string &name, bool a2u) {
int wlen = MultiByteToWideChar(a2u ? CP_ACP : CP_UTF8, 0,
name.c_str(), -1, NULL, 0);
if (wlen == 0) return;
WCHAR *wc = new WCHAR[wlen];
if (wc == NULL) return;
if (MultiByteToWideChar(a2u ? CP_ACP : CP_UTF8, 0, name.c_str(), -1,
wc, wlen) == 0) {
delete [] wc;
return;
}
int alen = WideCharToMultiByte(!a2u ? CP_ACP : CP_UTF8, 0, wc, wlen,
NULL, 0, NULL, NULL);
if (alen == 0) {
delete [] wc;
return;
}
CHAR *ac = new CHAR[alen];
if (ac == NULL) {
delete [] wc;
return;
}
WideCharToMultiByte(!a2u ? CP_ACP : CP_UTF8, 0, wc, wlen,
ac, alen, NULL, NULL);
delete [] wc;
if (ac == NULL) {
return;
}
name = ac;
delete [] ac;
return;
}
void replace_underbar2space(std::string &name) {
LOG_SAVE << "conv(A2U)-from:[" << name << "]" << std::endl;
conv_ansi_utf8(name, true);
LOG_SAVE << "conv(A2U)-to:[" << name << "]" << std::endl;
LOG_SAVE << "replace_underbar2space-from:[" << name << "]" << std::endl;
std::replace(name.begin(), name.end(), '_', ' ');
LOG_SAVE << "replace_underbar2space-to:[" << name << "]" << std::endl;
}
void replace_space2underbar(std::string &name) {
LOG_SAVE << "conv(U2A)-from:[" << name << "]" << std::endl;
conv_ansi_utf8(name, false);
LOG_SAVE << "conv(U2A)-to:[" << name << "]" << std::endl;
LOG_SAVE << "replace_space2underbar-from:[" << name << "]" << std::endl;
std::replace(name.begin(), name.end(), ' ', '_');
LOG_SAVE << "replace_space2underbar-to:[" << name << "]" << std::endl;
}
#else /* ! _WIN32 */
void replace_underbar2space(std::string &name) {
std::replace(name.begin(),name.end(),'_',' ');
}
void replace_space2underbar(std::string &name) {
std::replace(name.begin(),name.end(),' ','_');
}
#endif /* _WIN32 */
namespace savegame {
class save_index_class
{
public:
void rebuild(const std::string& name) {
std::string filename = name;
replace_space2underbar(filename);
time_t modified = file_create_time(get_saves_dir() + "/" + filename);
rebuild(name, modified);
}
void rebuild(const std::string& name, const time_t& modified) {
log_scope("load_summary_from_file");
config& summary = data(name);
try {
config full;
std::string dummy;
read_save_file(name, full, &dummy);
::extract_summary_from_config(full, summary);
} catch(game::load_game_failed&) {
summary["corrupt"] = true;
}
summary["mod_time"] = str_cast(static_cast<int>(modified));
write_save_index();
}
void remove(const std::string& name) {
config& root = data();
root.remove_attribute(name);
write_save_index();
}
void set_modified(const std::string& name, const time_t& modified) {
modified_[name] = modified;
}
config& get(const std::string& name) {
config& result = data(name);
time_t m = modified_[name];
config::attribute_value& mod_time = result["mod_time"];
if (mod_time.empty() || static_cast<time_t>(mod_time.to_int()) != m) {
rebuild(name, m);
}
return result;
}
public:
void write_save_index() {
log_scope("write_save_index()");
try {
scoped_ostream stream = ostream_file(get_save_index_file());
if (preferences::save_compression_format() != compression::NONE) {
// TODO: maybe allow writing this using bz2 too?
write_gz(*stream, data());
} else {
write(*stream, data());
}
} catch(io_exception& e) {
ERR_SAVE << "error writing to save index file: '" << e.what() << "'" << std::endl;
}
}
public:
save_index_class()
: loaded_(false)
, data_()
, modified_()
{
}
private:
config& data(const std::string& name) {
config& cfg = data();
if (config& sv = cfg.find_child("save", "save", name)) {
return sv;
}
config& res = cfg.add_child("save");
res["save"] = name;
return res;
}
config& data() {
if(loaded_ == false) {
try {
scoped_istream stream = istream_file(get_save_index_file());
try {
read_gz(data_, *stream);
} catch (boost::iostreams::gzip_error&) {
stream->seekg(0);
read(data_, *stream);
}
} catch(io_exception& e) {
ERR_SAVE << "error reading save index: '" << e.what() << "'" << std::endl;
} catch(config::error& e) {
ERR_SAVE << "error parsing save index config file:\n" << e.message << std::endl;
data_.clear();
}
loaded_ = true;
}
return data_;
}
private:
bool loaded_;
config data_;
std::map< std::string, time_t > modified_;
} save_index_manager;
class filename_filter {
public:
filename_filter(const std::string& filter) : filter_(filter) {
}
bool operator()(const std::string& filename) const {
return filename.end() == std::search(filename.begin(), filename.end(),
filter_.begin(), filter_.end());
}
private:
std::string filter_;
};
class create_save_info {
public:
create_save_info(const std::string* d = NULL) : dir(d ? *d : get_saves_dir()) {
}
save_info operator()(const std::string& filename) const {
std::string name = filename;
replace_underbar2space(name);
time_t modified = file_create_time(dir + "/" + filename);
save_index_manager.set_modified(name, modified);
return save_info(name, modified);
}
const std::string dir;
};
/** Get a list of available saves. */
std::vector<save_info> get_saves_list(const std::string* dir, const std::string* filter)
{
create_save_info creator(dir);
std::vector<std::string> filenames;
get_files_in_dir(creator.dir,&filenames);
if (filter) {
filenames.erase(std::remove_if(filenames.begin(), filenames.end(),
filename_filter(*filter)),
filenames.end());
}
std::vector<save_info> result;
std::transform(filenames.begin(), filenames.end(),
std::back_inserter(result), creator);
std::sort(result.begin(),result.end(),save_info_less_time());
return result;
}
const config& save_info::summary() const {
return save_index_manager.get(name());
}
std::string save_info::format_time_local() const
{
char time_buf[256] = {0};
tm* tm_l = localtime(&modified());
if (tm_l) {
const size_t res = strftime(time_buf,sizeof(time_buf),
(preferences::use_twelve_hour_clock_format() ? _("%a %b %d %I:%M %p %Y") : _("%a %b %d %H:%M %Y")),
tm_l);
if(res == 0) {
time_buf[0] = 0;
}
} else {
LOG_SAVE << "localtime() returned null for time " << this->modified() << ", save " << name();
}
return time_buf;
}
std::string save_info::format_time_summary() const
{
time_t t = modified();
return util::format_time_summary(t);
}
bool save_info_less_time::operator() (const save_info& a, const save_info& b) const {
if (a.modified() > b.modified()) {
return true;
} else if (a.modified() < b.modified()) {
return false;
// Special funky case; for files created in the same second,
// a replay file sorts less than a non-replay file. Prevents
// a timing-dependent bug where it may look like, at the end
// of a scenario, the replay and the autosave for the next
// scenario are displayed in the wrong order.
} else if (a.name().find(_(" replay"))==std::string::npos && b.name().find(_(" replay"))!=std::string::npos) {
return true;
} else if (a.name().find(_(" replay"))!=std::string::npos && b.name().find(_(" replay"))==std::string::npos) {
return false;
} else {
return a.name() > b.name();
}
}
static std::istream* find_save_file(const std::string &name, const std::string &alt_name, const std::vector<std::string> &suffixes) {
BOOST_FOREACH(const std::string &suf, suffixes) {
std::istream *file_stream = istream_file(get_saves_dir() + "/" + name + suf);
if (file_stream->fail()) {
delete file_stream;
file_stream = istream_file(get_saves_dir() + "/" + alt_name + suf);
}
if (!file_stream->fail())
return file_stream;
else
delete file_stream;
}
LOG_SAVE << "Could not open supplied filename '" << name << "'\n";
throw game::load_game_failed();
}
void read_save_file(const std::string& name, config& cfg, std::string* error_log)
{
std::string modified_name = name;
replace_space2underbar(modified_name);
static const std::vector<std::string> suffixes = boost::assign::list_of("")(".gz")(".bz2");
scoped_istream file_stream = find_save_file(modified_name, name, suffixes);
cfg.clear();
try{
/*
* Test the modified name, since it might use a .gz
* file even when not requested.
*/
if(is_gzip_file(modified_name)) {
read_gz(cfg, *file_stream);
} else if(is_bzip2_file(modified_name)) {
read_bz2(cfg, *file_stream);
} else {
read(cfg, *file_stream);
}
} catch(const std::ios_base::failure& e) {
LOG_SAVE << e.what();
if(error_log) {
*error_log += e.what();
}
throw game::load_game_failed();
} catch(const config::error &err) {
LOG_SAVE << err.message;
if(error_log) {
*error_log += err.message;
}
throw game::load_game_failed();
}
if(cfg.empty()) {
LOG_SAVE << "Could not parse file data into config\n";
throw game::load_game_failed();
}
}
bool save_game_exists(const std::string& name, compression::format compressed)
{
std::string fname = name;
replace_space2underbar(fname);
fname += compression::format_extension(compressed);
return file_exists(get_saves_dir() + "/" + fname);
}
void clean_saves(const std::string& label)
{
std::vector<save_info> games = get_saves_list();
std::string prefix = label + "-" + _("Auto-Save");
LOG_SAVE << "Cleaning saves with prefix '" << prefix << "'\n";
for (std::vector<save_info>::iterator i = games.begin(); i != games.end(); ++i) {
if (i->name().compare(0, prefix.length(), prefix) == 0) {
LOG_SAVE << "Deleting savegame '" << i->name() << "'\n";
delete_game(i->name());
}
}
}
void remove_old_auto_saves(const int autosavemax, const int infinite_auto_saves)
{
const std::string auto_save = _("Auto-Save");
int countdown = autosavemax;
if (countdown == infinite_auto_saves)
return;
std::vector<save_info> games = get_saves_list(NULL, &auto_save);
for (std::vector<save_info>::iterator i = games.begin(); i != games.end(); ++i) {
if (countdown-- <= 0) {
LOG_SAVE << "Deleting savegame '" << i->name() << "'\n";
delete_game(i->name());
}
}
}
void delete_game(const std::string& name)
{
std::string modified_name = name;
replace_space2underbar(modified_name);
remove((get_saves_dir() + "/" + name).c_str());
remove((get_saves_dir() + "/" + modified_name).c_str());
save_index_manager.remove(name);
}
loadgame::loadgame(display& gui, const config& game_config, game_state& gamestate)
: game_config_(game_config)
, gui_(gui)
, gamestate_(gamestate)
, filename_()
, difficulty_()
, load_config_()
, show_replay_(false)
, cancel_orders_(false)
, select_difficulty_(false)
{}
void loadgame::show_dialog(bool show_replay, bool cancel_orders)
{
//FIXME: Integrate the load_game dialog into this class
//something to watch for the curious, but not yet ready to go
if (gui2::new_widgets){
gui2::tgame_load load_dialog(game_config_);
load_dialog.show(gui_.video());
if (load_dialog.get_retval() == gui2::twindow::OK) {
select_difficulty_ = load_dialog.change_difficulty();
filename_ = load_dialog.filename();
show_replay_ = load_dialog.show_replay();
cancel_orders_ = load_dialog.cancel_orders();
}
} else {
bool show_replay_dialog = show_replay;
bool cancel_orders_dialog = cancel_orders;
filename_ = dialogs::load_game_dialog(gui_, game_config_, &select_difficulty_, &show_replay_dialog, &cancel_orders_dialog);
show_replay_ = show_replay_dialog;
cancel_orders_ = cancel_orders_dialog;
}
}
void loadgame::show_difficulty_dialog()
{
create_save_info creator;
save_info info = creator(filename_);
const config& cfg_summary = info.summary();
if ( cfg_summary["corrupt"].to_bool() || (cfg_summary["replay"].to_bool() && !cfg_summary["snapshot"].to_bool(true))
|| (!cfg_summary["turn"].empty()) )
return;
const config::const_child_itors &campaigns = game_config_.child_range("campaign");
std::vector<std::string> difficulty_descriptions;
std::vector<std::string> difficulties;
BOOST_FOREACH(const config &campaign, campaigns)
{
if (campaign["id"] == cfg_summary["campaign"]) {
difficulty_descriptions = utils::split(campaign["difficulty_descriptions"], ';');
difficulties = utils::split(campaign["difficulties"], ',');
break;
}
}
if (difficulty_descriptions.empty())
return;
#if 0
int default_difficulty = -1;
for (size_t i = 0; i < difficulties.size(); i++) {
if (difficulties[i] == cfg_summary["difficulty"]) {
default_difficulty = i;
break;
}
}
#endif
gui2::tcampaign_difficulty difficulty_dlg(difficulty_descriptions);
difficulty_dlg.show(gui_.video());
if (difficulty_dlg.get_retval() != gui2::twindow::OK) {
throw load_game_cancelled_exception();
}
difficulty_ = difficulties[difficulty_dlg.selected_index()];
}
void loadgame::load_game()
{
show_dialog(false, false);
if(filename_ != "")
throw game::load_game_exception(filename_, show_replay_, cancel_orders_, select_difficulty_, difficulty_);
}
void loadgame::load_game(
const std::string& filename
, const bool show_replay
, const bool cancel_orders
, const bool select_difficulty
, const std::string& difficulty)
{
filename_ = filename;
difficulty_ = difficulty;
select_difficulty_ = select_difficulty;
if (filename_.empty()){
show_dialog(show_replay, cancel_orders);
}
else{
show_replay_ = show_replay;
cancel_orders_ = cancel_orders;
}
if (filename_.empty())
throw load_game_cancelled_exception();
if (select_difficulty_)
show_difficulty_dialog();
std::string error_log;
read_save_file(filename_, load_config_, &error_log);
convert_old_saves(load_config_);
if(!error_log.empty()) {
try {
gui2::show_error_message(gui_.video(),
_("Warning: The file you have tried to load is corrupt. Loading anyway.\n") +
error_log);
} catch (utf8::invalid_utf8_exception&) {
gui2::show_error_message(gui_.video(),
_("Warning: The file you have tried to load is corrupt. Loading anyway.\n") +
std::string("(UTF-8 ERROR)"));
}
}
if (!difficulty_.empty()){
load_config_["difficulty"] = difficulty_;
}
gamestate_.classification().campaign_define = load_config_["campaign_define"].str();
gamestate_.classification().campaign_type = lexical_cast_default<game_classification::CAMPAIGN_TYPE> (load_config_["campaign_type"].str(), game_classification::SCENARIO);
gamestate_.classification().campaign_xtra_defines = utils::split(load_config_["campaign_extra_defines"]);
gamestate_.classification().version = load_config_["version"].str();
gamestate_.classification().difficulty = load_config_["difficulty"].str();
/*
if (config & carryover_sides_start = load_config_.child("carryover_sides_start")) {
std::string load_config_difficulty = carryover_sides_start["difficulty"];
gamestate_.classification().difficulty = load_config_difficulty;
} else {
gamestate_.classification().difficulty = difficulty_;
}
*/
check_version_compatibility();
}
void loadgame::check_version_compatibility()
{
if (gamestate_.classification().version == game_config::version) {
return;
}
const version_info save_version = gamestate_.classification().version;
const version_info &wesnoth_version = game_config::wesnoth_version;
// If the version isn't good, it probably isn't a compatible stable one,
// and the following comparisons would throw.
if (!save_version.good()) {
const std::string message = _("The save has corrupt version information ($version_number|) and cannot be loaded.");
utils::string_map symbols;
symbols["version_number"] = gamestate_.classification().version;
gui2::show_error_message(gui_.video(), utils::interpolate_variables_into_string(message, &symbols));
throw load_game_cancelled_exception();
}
// Even minor version numbers indicate stable releases which are
// compatible with each other.
if (wesnoth_version.minor_version() % 2 == 0 &&
wesnoth_version.major_version() == save_version.major_version() &&
wesnoth_version.minor_version() == save_version.minor_version())
{
return;
}
// Do not load if too old. If either the savegame or the current
// game has the version 'test', load. This 'test' version is never
// supposed to occur, except when Soliton is testing MP servers.
if (save_version < game_config::min_savegame_version &&
save_version != game_config::test_version &&
wesnoth_version != game_config::test_version)
{
const std::string message = _("This save is from an old, unsupported version ($version_number|) and cannot be loaded.");
utils::string_map symbols;
symbols["version_number"] = save_version.str();
gui2::show_error_message(gui_.video(), utils::interpolate_variables_into_string(message, &symbols));
throw load_game_cancelled_exception();
}
int res = gui2::twindow::OK;
if(preferences::confirm_load_save_from_different_version()) {
const std::string message = _("This save is from a different version of the game ($version_number|). Do you wish to try to load it?");
utils::string_map symbols;
symbols["version_number"] = save_version.str();
res = gui2::show_message(gui_.video(), _("Load Game"), utils::interpolate_variables_into_string(message, &symbols),
gui2::tmessage::yes_no_buttons);
}
if(res == gui2::twindow::CANCEL) {
throw load_game_cancelled_exception();
}
}
void loadgame::set_gamestate()
{
gamestate_ = game_state(load_config_, show_replay_);
// Get the status of the random in the snapshot.
// For a replay we need to restore the start only, the replaying gets at
// proper location.
// For normal loading also restore the call count.
int seed = load_config_["random_seed"].to_int(42);
if(seed == 42){
config cfg = load_config_.child_or_empty("carryover_sides_start");
seed = cfg["random_seed"].to_int(42);
}
unsigned calls = show_replay_ ? 0 : gamestate_.snapshot["random_calls"].to_int();
carryover_info sides(gamestate_.carryover_sides_start);
sides.rng().seed_random(seed, calls);
gamestate_.carryover_sides_start = sides.to_config();
}
void loadgame::load_multiplayer_game()
{
show_dialog(false, false);
if (filename_.empty())
throw load_game_cancelled_exception();
std::string error_log;
{
cursor::setter cur(cursor::WAIT);
log_scope("load_game");
read_save_file(filename_, load_config_, &error_log);
copy_era(load_config_);
gamestate_ = game_state(load_config_);
}
if(!error_log.empty()) {
gui2::show_error_message(gui_.video(),
_("The file you have tried to load is corrupt: '") +
error_log);
throw load_game_cancelled_exception();
}
if(gamestate_.classification().campaign_type != game_classification::MULTIPLAYER) {
gui2::show_transient_error_message(gui_.video(), _("This is not a multiplayer save."));
throw load_game_cancelled_exception();
}
check_version_compatibility();
}
void loadgame::fill_mplevel_config(config& level){
gamestate_.mp_settings().saved_game = true;
// If we have a start of scenario MP campaign scenario the snapshot
// is empty the starting position contains the wanted info.
const config& start_data = !gamestate_.snapshot.empty() ? gamestate_.snapshot : gamestate_.replay_start();
level.add_child("map", start_data.child_or_empty("map"));
level["id"] = start_data["id"];
level["name"] = start_data["name"];
level["completion"] = start_data["completion"];
level["next_underlying_unit_id"] = start_data["next_underlying_unit_id"];
// Probably not needed.
level["turn"] = start_data["turn_at"];
level["turn_at"] = start_data["turn_at"];
level.add_child("multiplayer", gamestate_.mp_settings().to_config());
//Start-of-scenario save
if(gamestate_.snapshot.empty()){
//For a start-of-scenario-save, write the data to the starting_pos and not the snapshot, since
//there should only be snapshots for midgame reloads
if (config &c = level.child("replay_start")) {
c.merge_with(start_data);
} else {
level.add_child("replay_start") = start_data;
}
level.add_child("snapshot") = config();
} else {
level.add_child("snapshot") = start_data;
level.add_child("replay_start") = gamestate_.replay_start();
}
level["random_seed"] = start_data["random_seed"];
level["random_calls"] = start_data["random_calls"];
// Adds the replay data, and the replay start, to the level,
// so clients can receive it.
level.add_child("replay") = gamestate_.replay_data;
level.add_child("statistics") = statistics::write_stats();
}
void loadgame::copy_era(config &cfg)
{
const config &replay_start = cfg.child("replay_start");
if (!replay_start) return;
const config &era = replay_start.child("era");
if (!era) return;
config &snapshot = cfg.child("snapshot");
if (!snapshot) return;
snapshot.add_child("era", era);
}
savegame::savegame(game_state& gamestate, const compression::format compress_saves, const std::string& title)
: gamestate_(gamestate)
, snapshot_()
, filename_()
, title_(title)
, error_message_(_("The game could not be saved: "))
, show_confirmation_(false)
, compress_saves_(compress_saves)
{}
bool savegame::save_game_automatic(CVideo& video, bool ask_for_overwrite, const std::string& filename)
{
if (filename == "")
create_filename();
else
filename_ = filename;
if (ask_for_overwrite){
if (!check_overwrite(video)) {
return save_game_interactive(video, "", gui::OK_CANCEL);
}
}
return save_game(&video);
}
bool savegame::save_game_interactive(CVideo& video, const std::string& message,
gui::DIALOG_TYPE dialog_type)
{
show_confirmation_ = true;
create_filename();
int res = gui2::twindow::OK;
bool exit = true;
do{
try{
res = show_save_dialog(video, message, dialog_type);
exit = true;
if (res == gui2::twindow::OK){
exit = check_overwrite(video);
}
}
catch (illegal_filename_exception){
exit = false;
}
}
while (!exit);
if (res == 2) //Quit game
throw end_level_exception(QUIT);
if (res != gui2::twindow::OK)
return false;
return save_game(&video);
}
int savegame::show_save_dialog(CVideo& video, const std::string& message, const gui::DIALOG_TYPE dialog_type)
{
int res = 0;
std::string filename = filename_;
if (dialog_type == gui::OK_CANCEL){
gui2::tgame_save dlg(filename, title_);
dlg.show(video);
res = dlg.get_retval();
}
else if (dialog_type == gui::YES_NO){
gui2::tgame_save_message dlg(filename, title_, message);
dlg.show(video);
res = dlg.get_retval();
}
check_filename(filename, video);
set_filename(filename);
return res;
}
bool savegame::check_overwrite(CVideo& video)
{
std::string filename = filename_;
if (save_game_exists(filename, compress_saves_)) {
std::stringstream message;
message << _("Save already exists. Do you want to overwrite it?") << "\n" << _("Name: ") << filename;
int retval = gui2::show_message(video, _("Overwrite?"), message.str(), gui2::tmessage::yes_no_buttons);
return retval == gui2::twindow::OK;
} else {
return true;
}
}
void savegame::check_filename(const std::string& filename, CVideo& video)
{
if (is_compressed_file(filename)) {
gui2::show_error_message(video, _("Save names should not end on '.gz' or '.bz2'. "
"Please remove the extension."));
throw illegal_filename_exception();
}
}
bool savegame::is_illegal_file_char(char c)
{
return c == '/' || c == '\\' || c == ':'
#ifdef _WIN32
|| c == '?' || c == '|' || c == '<' || c == '>' || c == '*' || c == '"'
#endif
;
}
void savegame::set_filename(std::string filename)
{
filename.erase(std::remove_if(filename.begin(), filename.end(),
is_illegal_file_char), filename.end());
filename_ = filename;
}
void savegame::before_save()
{
gamestate_.replay_data = recorder.get_replay_data();
}
bool savegame::save_game(CVideo* video, const std::string& filename)
{
static std::string parent, grandparent;
try {
Uint32 start, end;
start = SDL_GetTicks();
if (filename_ == "")
filename_ = filename;
before_save();
// The magic moment that does save threading; after
// each save, the filename of the save file becomes
// the parent for the next. *Unless* the parent file
// has the same name as the savefile, in which case we
// use the grandparent name. When user loads a savegame,
// we load its correct parent link along with it.
if (filename_ == parent) {
gamestate_.classification().parent = grandparent;
} else {
gamestate_.classification().parent = parent;
}
LOG_SAVE << "Setting parent of '" << filename_<< "' to " << gamestate_.classification().parent << std::endl;
write_game_to_disk(filename_);
if (resources::persist != NULL) {
resources::persist->end_transaction();
resources::persist ->start_transaction();
}
grandparent = parent;
parent = filename_;
end = SDL_GetTicks();
LOG_SAVE << "Milliseconds to save " << filename_ << ": " << end - start << std::endl;
if (video != NULL && show_confirmation_)
gui2::show_transient_message(*video, _("Saved"), _("The game has been saved."));
return true;
} catch(game::save_game_failed& e) {
ERR_SAVE << error_message_ << e.message << std::endl;
if (video != NULL){
gui2::show_error_message(*video, error_message_ + e.message);
//do not bother retrying, since the user can just try to save the game again
//maybe show a yes-no dialog for "disable autosaves now"?
}
return false;
};
}
void savegame::write_game_to_disk(const std::string& filename)
{
LOG_SAVE << "savegame::save_game" << std::endl;
filename_ = filename;
filename_ += compression::format_extension(compress_saves_);
std::stringstream ss;
{
config_writer out(ss, compress_saves_);
write_game(out);
finish_save_game(out);
}
scoped_ostream os(open_save_game(filename_));
(*os) << ss.str();
if (!os->good()) {
throw game::save_game_failed(_("Could not write to file"));
}
}
void savegame::write_game(config_writer &out)
{
log_scope("write_game");
out.write_key_val("version", game_config::version);
out.write_key_val("next_underlying_unit_id", lexical_cast<std::string>(n_unit::id_manager::instance().get_save_id()));
gamestate_.write_config(out);
out.open_child("statistics");
statistics::write_stats(out);
out.close_child("statistics");
}
void savegame::finish_save_game(const config_writer &out)
{
try {
if(!out.good()) {
throw game::save_game_failed(_("Could not write to file"));
}
save_index_manager.remove(gamestate_.classification().label);
} catch(io_exception& e) {
throw game::save_game_failed(e.what());
}
}
// Throws game::save_game_failed
scoped_ostream savegame::open_save_game(const std::string &label)
{
std::string name = label;
replace_space2underbar(name);
try {
return scoped_ostream(ostream_file(get_saves_dir() + "/" + name));
} catch(io_exception& e) {
throw game::save_game_failed(e.what());
}
}
scenariostart_savegame::scenariostart_savegame(game_state &gamestate, const compression::format compress_saves)
: savegame(gamestate, compress_saves)
{
set_filename(gamestate.classification().label);
}